debuggerengine.cpp 45 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
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28 29
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
30 31 32 33 34 35
**
**************************************************************************/

#include "debuggerengine.h"

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

42 43
#include "memoryagent.h"
#include "disassembleragent.h"
44 45 46 47 48 49 50 51 52
#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
53
#include <coreplugin/icore.h>
54
#include <coreplugin/ifile.h>
hjk's avatar
hjk committed
55
#include <coreplugin/editormanager/editormanager.h>
56 57
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
58 59

#include <texteditor/itexteditor.h>
60
#include <texteditor/basetextmark.h>
hjk's avatar
hjk committed
61

62 63 64 65 66
#include <utils/savedaction.h>
#include <utils/qtcassert.h>

#include <QtCore/QDebug>
#include <QtCore/QTimer>
67
#include <QtCore/QFutureInterface>
68

69
#include <QtGui/QMessageBox>
70

hjk's avatar
hjk committed
71
using namespace Core;
72
using namespace Debugger::Internal;
hjk's avatar
hjk committed
73 74
using namespace ProjectExplorer;
using namespace TextEditor;
75

76 77 78 79
enum { debug = 0 };

#define SDEBUG(s) if (!debug) {} else qDebug() << s;
#define XSDEBUG(s) qDebug() << s
80

81

82 83 84 85 86 87
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

88 89
namespace Debugger {

Friedemann Kleint's avatar
Friedemann Kleint committed
90 91 92 93 94 95 96 97 98 99 100
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;
}

101 102
QDebug operator<<(QDebug d, DebuggerState state)
{
hjk's avatar
hjk committed
103 104
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
105 106 107 108 109 110 111
}

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
112
            << " processArgs=" << sp.processArgs
113 114 115 116 117 118 119
            << " 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
120
            << " useServerStartScript=" << sp.useServerStartScript
121
            << " serverStartScript=" << sp.serverStartScript
122
            << " abi=" << sp.toolChainAbi.toString() << '\n';
123 124 125
    return str;
}

126

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
///////////////////////////////////////////////////////////////////////
//
// 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() {}
145
    TextEditor::ITextMark::Priority priority() const { return TextEditor::ITextMark::HighPriority; }
146 147 148 149
};



150 151 152 153 154 155
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

156
class DebuggerEnginePrivate : public QObject
157
{
158 159
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
185

186
public slots:
187
    void doSetupEngine();
hjk's avatar
hjk committed
188 189
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
190 191
    void doShutdownEngine();
    void doShutdownInferior();
192
    void doInterruptInferior();
hjk's avatar
hjk committed
193
    void doFinishDebugger();
hjk's avatar
hjk committed
194

195 196 197 198 199 200 201 202 203 204 205 206 207 208
    void queueSetupEngine()
    {
        m_engine->setState(EngineSetupRequested);
        m_engine->showMessage(_("QUEUE: SETUP ENGINE"));
        QTimer::singleShot(0, this, SLOT(doSetupEngine()));
    }

    void queueSetupInferior()
    {
        m_engine->setState(InferiorSetupRequested);
        m_engine->showMessage(_("QUEUE: SETUP INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doSetupInferior()));
    }

209 210
    void queueRunEngine()
    {
hjk's avatar
hjk committed
211 212 213 214 215
        m_engine->setState(EngineRunRequested);
        m_engine->showMessage(_("QUEUE: RUN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doRunEngine()));
    }

216 217
    void queueShutdownEngine()
    {
hjk's avatar
hjk committed
218 219 220 221 222
        m_engine->setState(EngineShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doShutdownEngine()));
    }

223 224
    void queueShutdownInferior()
    {
hjk's avatar
hjk committed
225 226 227 228 229
        m_engine->setState(InferiorShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doShutdownInferior()));
    }

230 231
    void queueFinishDebugger()
    {
232 233 234 235
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
236 237 238
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

239 240
    void raiseApplication()
    {
241 242
        QTC_ASSERT(runControl(), return);
        runControl()->bringApplicationToForeground(m_inferiorPid);
243 244
    }

245
    void scheduleResetLocation()
246
    {
247
        m_stackHandler.scheduleResetLocation();
248
        m_disassemblerAgent.scheduleResetLocation();
249 250 251 252
        m_locationTimer.setSingleShot(true);
        m_locationTimer.start(80);
    }

253
    void resetLocation()
254 255 256
    {
        m_locationTimer.stop();
        m_locationMark.reset();
257 258
        m_stackHandler.resetLocation();
        m_disassemblerAgent.resetLocation();
259 260
    }

261
public:
hjk's avatar
hjk committed
262
    DebuggerState state() const { return m_state; }
263 264 265
    bool isMasterEngine() const { return m_engine->isMasterEngine(); }
    DebuggerRunControl *runControl() const
        { return m_masterEngine ? m_masterEngine->runControl() : m_runControl; }
hjk's avatar
hjk committed
266

267
    DebuggerEngine *m_engine; // Not owned.
268
    DebuggerEngine *m_masterEngine; // Not owned
269 270 271
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
272 273

    // The current state.
274 275
    DebuggerState m_state;

hjk's avatar
hjk committed
276 277 278 279 280 281
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

282 283 284 285 286 287 288 289
    qint64 m_inferiorPid;

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

292 293
    DisassemblerAgent m_disassemblerAgent;
    MemoryAgent m_memoryAgent;
294 295
    QScopedPointer<TextEditor::BaseTextMark> m_locationMark;
    QTimer m_locationTimer;
296 297

    bool m_isStateDebugging;
298 299 300 301 302 303 304 305 306
};


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

307 308 309
DebuggerEngine::DebuggerEngine(const DebuggerStartParameters &startParameters,
        DebuggerEngine *parentEngine)
  : d(new DebuggerEnginePrivate(this, parentEngine, startParameters))
310 311 312 313 314
{
}

DebuggerEngine::~DebuggerEngine()
{
315 316
    disconnect();
    delete d;
317 318
}

319 320 321 322 323 324 325 326 327 328 329
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)
        SN(InferiorSetupRequested)
        SN(InferiorSetupFailed)
330
        SN(InferiorSetupOk)
331 332 333 334 335 336 337 338
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
        SN(InferiorUnrunnable)
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
        SN(InferiorStopFailed)
339
        SN(InferiorExitOk)
340 341 342 343 344 345 346 347 348 349 350 351
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
        SN(InferiorShutdownFailed)
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
    }
    return "<unknown>";
#    undef SN
}

352
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
353
{
354
    showMessage(msg, StatusBar, timeout);
355
}
356

357 358 359 360 361 362 363 364 365 366 367 368 369 370
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
{
371 372 373
    return d->m_masterEngine
        ? d->m_masterEngine->modulesHandler()
        : &d->m_modulesHandler;
374 375 376 377
}

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

StackHandler *DebuggerEngine::stackHandler() const
{
hjk's avatar
hjk committed
385 386 387 388
    //return d->m_masterEngine
    //    ? d->m_masterEngine->stackHandler()
    //    : &d->m_stackHandler;
    return &d->m_stackHandler;
389 390 391 392
}

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

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

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

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

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

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

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

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

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

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

468 469 470 471 472 473 474 475
QAbstractItemModel *DebuggerEngine::toolTipsModel() const
{
    QAbstractItemModel *model = watchHandler()->model(TooltipsWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("TooltipsModel"));
    return model;
}

476 477
QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
478
    QAbstractItemModel *model = sourceFilesHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
479 480 481
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
482 483
}

484
void DebuggerEngine::fetchMemory(MemoryAgent *, QObject *,
485 486 487 488 489 490
        quint64 addr, quint64 length)
{
    Q_UNUSED(addr);
    Q_UNUSED(length);
}

hjk's avatar
hjk committed
491 492 493 494 495 496 497
void DebuggerEngine::changeMemory(MemoryAgent *, QObject *,
        quint64 addr, const QByteArray &data)
{
    Q_UNUSED(addr);
    Q_UNUSED(data);
}

498 499 500 501 502 503 504 505
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
{
506 507 508 509
    if (d->m_masterEngine) {
        d->m_masterEngine->showMessage(msg, channel, timeout);
        return;
    }
510 511
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
512
    debuggerCore()->showMessage(msg, channel, timeout);
513 514 515 516 517
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
518 519 520 521
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
522 523
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
524

525 526 527 528 529 530 531
    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();

532 533 534 535 536
    d->m_runControl = runControl;

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

537 538
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
539 540

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
541
    debuggerCore()->action(OperateByInstruction)
542 543
        ->setEnabled(engineCapabilities & DisassemblerCapability);

544 545
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
546 547
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
548
    d->m_progress.setProgressValue(200);
549
    d->queueSetupEngine();
550 551 552 553
}

void DebuggerEngine::resetLocation()
{
554 555
    // Do it after some delay to avoid flicker.
    d->scheduleResetLocation();
556 557
}

558
void DebuggerEngine::gotoLocation(const Location &loc)
559
{
560 561 562 563 564
    if (debuggerCore()->boolSetting(OperateByInstruction) || !loc.hasDebugInfo()) {
        d->m_disassemblerAgent.setTryMixed(true);
        d->m_disassemblerAgent.setLocation(loc);
        return;
    }
565 566 567 568
    // CDB might hit on breakpoints while shutting down.
    //if (m_shuttingDown)
    //    return;

569
    d->resetLocation();
570

571 572
    const QString file = loc.fileName();
    const int line = loc.lineNumber();
hjk's avatar
hjk committed
573 574
    EditorManager *editorManager = EditorManager::instance();
    QList<IEditor *> editors = editorManager->editorsForFileName(file);
575
    IEditor *editor = 0;
hjk's avatar
hjk committed
576
    if (editors.isEmpty()) {
577 578 579 580 581 582 583 584
        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
585
    }
586
    ITextEditor *texteditor = qobject_cast<ITextEditor *>(editor);
hjk's avatar
hjk committed
587 588 589
    if (texteditor)
        texteditor->gotoLine(line, 0);

590
    if (loc.needsMarker())
591
        d->m_locationMark.reset(new LocationMark(file, line));
592 593

    // FIXME: Breaks with split views.
594
    if (!d->m_memoryAgent.hasVisibleEditor() || loc.needsRaise())
595
        editorManager->activateEditor(editor);
596
    //qDebug() << "MEMORY: " << d->m_memoryAgent.hasVisibleEditor();
597 598
}

599 600 601
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
602
    showMessage("HANDLE RUNCONTROL START FAILED");
603
    d->m_runControl = 0;
604
    d->m_progress.setProgressValue(900);
605 606
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
607 608
}

609 610
// Called from RunControl.
void DebuggerEngine::handleFinished()
611
{
612
    showMessage("HANDLE RUNCONTROL FINISHED");
613
    d->m_runControl = 0;
614 615
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
}

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
644
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
645 646 647 648 649 650 651 652 653
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
    return d->m_startParameters.dumperLibraryLocations;
}

void DebuggerEngine::showQtDumperLibraryWarning(const QString &details)
{
654
    debuggerCore()->showQtDumperLibraryWarning(details);
655 656 657 658 659 660 661 662 663 664 665 666
}

QString DebuggerEngine::qtDumperLibraryName() const
{
    return startParameters().dumperLibrary;
}

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

hjk's avatar
hjk committed
667
DebuggerState DebuggerEngine::lastGoodState() const
668
{
hjk's avatar
hjk committed
669 670 671 672 673 674 675
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
677 678 679
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
680
    case DebuggerNotReady:
681
        return to == EngineSetupRequested;
682

hjk's avatar
hjk committed
683
    case EngineSetupRequested:
684 685
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
686 687 688
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
689
    case EngineSetupOk:
hjk's avatar
hjk committed
690
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
691

hjk's avatar
hjk committed
692
    case InferiorSetupRequested:
693
        return to == InferiorSetupOk || to == InferiorSetupFailed;
hjk's avatar
hjk committed
694
    case InferiorSetupFailed:
hjk's avatar
hjk committed
695
        return to == EngineShutdownRequested;
696 697
    case InferiorSetupOk:
        return to == EngineRunRequested;
hjk's avatar
hjk committed
698 699

    case EngineRunRequested:
hjk's avatar
hjk committed
700 701 702 703
        return to == EngineRunFailed
            || to == InferiorRunOk
            || to == InferiorStopOk
            || to == InferiorUnrunnable;
hjk's avatar
hjk committed
704
    case EngineRunFailed:
705
        return to == EngineShutdownRequested;
hjk's avatar
hjk committed
706 707 708 709 710 711

    case InferiorRunRequested:
        return to == InferiorRunOk || to == InferiorRunFailed;
    case InferiorRunFailed:
        return to == InferiorStopOk;
    case InferiorRunOk:
712 713 714
        return to == InferiorStopRequested
            || to == InferiorStopOk // A spontaneous stop.
            || to == InferiorExitOk;
hjk's avatar
hjk committed
715 716 717 718 719

    case InferiorStopRequested:
        return to == InferiorStopOk || to == InferiorStopFailed;
    case InferiorStopOk:
        return to == InferiorRunRequested || to == InferiorShutdownRequested
720
            || to == InferiorStopOk || InferiorExitOk;
721
    case InferiorStopFailed:
hjk's avatar
hjk committed
722
        return to == EngineShutdownRequested;
723

724 725 726
    case InferiorExitOk:
        return to == InferiorShutdownOk;

727
    case InferiorUnrunnable:
hjk's avatar
hjk committed
728 729 730 731 732
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
733
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
734
        return to == EngineShutdownRequested;
735

hjk's avatar
hjk committed
736
    case EngineShutdownRequested:
737
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
738 739 740 741 742 743
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
744
        return to == EngineSetupRequested; // Happens on restart.
745 746
    }

747
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
748 749 750
    return false;
}

751 752 753 754 755 756 757 758 759 760 761 762 763
void DebuggerEngine::setupSlaveEngine()
{
    QTC_ASSERT(state() == DebuggerNotReady, /**/);
    d->queueSetupEngine();
}

void DebuggerEnginePrivate::doSetupEngine()
{
    m_engine->showMessage(_("CALL: SETUP ENGINE"));
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << m_engine << state());
    m_engine->setupEngine();
}

764
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
765
{
hjk's avatar
hjk committed
766
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
767
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
768
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
769
    if (isMasterEngine() && runControl())
770
        runControl()->startFailed();
hjk's avatar
hjk committed
771
    setState(DebuggerFinished);
hjk's avatar
hjk committed
772 773
}

774
void DebuggerEngine::notifyEngineSetupOk()
775
{
hjk's avatar
hjk committed
776
    showMessage(_("NOTE: ENGINE SETUP OK"));
777
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
778
    setState(EngineSetupOk);
hjk's avatar
hjk committed
779
    showMessage(_("QUEUE: SETUP INFERIOR"));
780
    if (isMasterEngine())
781 782 783 784 785 786 787
        d->queueSetupInferior();
}

void DebuggerEngine::setupSlaveInferior()
{
    QTC_ASSERT(state() == EngineSetupOk, /**/);
    d->queueSetupInferior();
788 789
}

hjk's avatar
hjk committed
790
void DebuggerEnginePrivate::doSetupInferior()
791
{
792
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
793
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << m_engine << state());
794
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
795 796 797 798 799
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
800
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
801
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
hjk's avatar
hjk committed
802
    setState(InferiorSetupFailed);
803 804
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
805 806 807 808
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
809
    showMessage(_("NOTE: INFERIOR SETUP OK"));
810 811 812 813
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
    setState(InferiorSetupOk);
    if (isMasterEngine())
        d->queueRunEngine();
hjk's avatar
hjk committed
814 815
}

816 817 818 819 820 821 822
void DebuggerEngine::runSlaveEngine()
{
    QTC_ASSERT(isSlaveEngine(), return);
    QTC_ASSERT(state() == InferiorSetupOk, /**/);
    d->queueRunEngine();
}

hjk's avatar
hjk committed
823 824
void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
825
    m_engine->showMessage(_("CALL: RUN ENGINE"));
826
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << m_engine << state());
827
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
828 829 830
    m_engine->runEngine();
}

hjk's avatar
hjk committed
831 832
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
833
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
834 835
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
836
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
837 838 839 840 841
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
842
    showMessage(_("NOTE: ENGINE RUN FAILED"));
843
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
844 845 846
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
847
    setState(EngineRunFailed);
848 849
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
850 851 852 853
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
854
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
855 856
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
857
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
858
    setState(InferiorRunOk);
hjk's avatar
hjk committed
859 860 861 862
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
863
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
864 865
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
866
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
867
    setState(InferiorStopOk);
hjk's avatar
hjk committed
868 869 870 871
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
872
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
873
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << this << state());
hjk's avatar
hjk committed
874 875 876 877 878
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
879
    showMessage(_("NOTE: INFERIOR RUN OK"));
880
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
881 882 883 884 885
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
886
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
887
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
888 889
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
890 891
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
892 893 894 895
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
896 897
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
898
    if (isDying()) {
hjk's avatar
hjk committed
899 900 901 902 903 904 905 906 907 908 909 910 911
        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
912
    }
913
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << this << state());
hjk's avatar
hjk committed
914
    setState(InferiorStopOk);
hjk's avatar
hjk committed
915 916
}

hjk's avatar
hjk committed
917
void DebuggerEngine::notifyInferiorSpontaneousStop()
918
{
919
    showMessage(_("NOTE: INFERIOR SPONTANEOUS STOP"));
920
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << this << state());
921
    setState(InferiorStopOk);
922 923
}

hjk's avatar
hjk committed
924
void DebuggerEngine::notifyInferiorStopFailed()
925
{