debuggerengine.cpp 42.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#include "debuggerengine.h"

#include "debuggeractions.h"
#include "debuggeragents.h"
#include "debuggerrunner.h"
#include "debuggeroutputwindow.h"
#include "debuggerplugin.h"
#include "debuggerstringutils.h"

#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
47
#include "watchutils.h"
48

hjk's avatar
hjk committed
49 50
#include <coreplugin/icore.h>
#include <coreplugin/editormanager/editormanager.h>
51 52
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
53

54 55 56 57 58 59 60 61 62 63
#include <projectexplorer/debugginghelper.h>
#include <projectexplorer/environment.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/target.h>
#include <projectexplorer/buildconfiguration.h>
#include <projectexplorer/applicationrunconfiguration.h> // For LocalApplication*

#include <qt4projectmanager/qt4projectmanagerconstants.h>

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

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

#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QTimer>
73
#include <QtCore/QFutureInterface>
74 75 76 77

#include <QtGui/QAbstractItemView>
#include <QtGui/QStandardItemModel>
#include <QtGui/QAction>
78
#include <QtGui/QMenu>
79
#include <QtGui/QMessageBox>
hjk's avatar
hjk committed
80
#include <QtGui/QPlainTextEdit>
81
#include <QtGui/QPushButton>
hjk's avatar
hjk committed
82 83
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
84 85 86 87
#include <QtGui/QTextDocument>
#include <QtGui/QTreeWidget>


hjk's avatar
hjk committed
88
using namespace Core;
89 90
using namespace Debugger;
using namespace Debugger::Internal;
hjk's avatar
hjk committed
91 92
using namespace ProjectExplorer;
using namespace TextEditor;
93

hjk's avatar
hjk committed
94 95 96 97 98 99 100
//#define DEBUG_STATE 1
#if DEBUG_STATE
#   define SDEBUG(s) qDebug() << s
#else
#   define SDEBUG(s)
#endif
# define XSDEBUG(s) qDebug() << s
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125

///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

DebuggerStartParameters::DebuggerStartParameters()
  : attachPID(-1),
    useTerminal(false),
    breakAtMain(false),
    toolChainType(ToolChain::UNKNOWN),
    startMode(NoStartMode)
{}

void DebuggerStartParameters::clear()
{
    *this = DebuggerStartParameters();
}


namespace Debugger {

QDebug operator<<(QDebug d, DebuggerState state)
{
hjk's avatar
hjk committed
126 127
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
}

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    const QString sep = QString(QLatin1Char(','));
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
            << " processArgs=" << sp.processArgs.join(sep)
            << " environment=<" << sp.environment.size() << " variables>"
            << " workingDir=" << sp.workingDirectory
            << " attachPID=" << sp.attachPID
            << " useTerminal=" << sp.useTerminal
            << " remoteChannel=" << sp.remoteChannel
            << " remoteArchitecture=" << sp.remoteArchitecture
            << " symbolFileName=" << sp.symbolFileName
            << " serverStartScript=" << sp.serverStartScript
            << " toolchain=" << sp.toolChainType << '\n';
    return str;
}


namespace Internal {

const char *DebuggerEngine::stateName(int s)
{
#    define SN(x) case x: return #x;
    switch (s) {
        SN(DebuggerNotReady)
hjk's avatar
hjk committed
157
        SN(EngineSetupRequested)
158 159
        SN(EngineSetupOk)
        SN(EngineSetupFailed)
hjk's avatar
hjk committed
160 161
        SN(EngineRunFailed)
        SN(InferiorSetupRequested)
hjk's avatar
hjk committed
162
        SN(InferiorSetupFailed)
hjk's avatar
hjk committed
163 164 165 166
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
167
        SN(InferiorUnrunnable)
hjk's avatar
hjk committed
168 169
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
170
        SN(InferiorStopFailed)
hjk's avatar
hjk committed
171 172
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
173
        SN(InferiorShutdownFailed)
hjk's avatar
hjk committed
174 175 176 177
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
178 179 180 181 182
    }
    return "<unknown>";
#    undef SN
}

183

184 185 186 187 188 189 190 191 192
//////////////////////////////////////////////////////////////////////
//
// CommandHandler
//
//////////////////////////////////////////////////////////////////////

class CommandHandler : public QStandardItemModel
{
public:
193
    explicit CommandHandler(DebuggerEngine *engine) : m_engine(engine) {}
194 195 196 197
    bool setData(const QModelIndex &index, const QVariant &value, int role);
    QAbstractItemModel *model() { return this; }

private:
198
    QPointer<DebuggerEngine> m_engine;
199 200
};

201
bool CommandHandler::setData(const QModelIndex &, const QVariant &value, int role)
202
{
203
    QTC_ASSERT(m_engine, qDebug() << value << role; return false);
204 205
    m_engine->handleCommand(role, value);
    return true;
206 207 208 209 210 211 212 213 214
}


//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

215
class DebuggerEnginePrivate : public QObject
216
{
217 218
    Q_OBJECT

219 220 221 222
public:
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
      : m_engine(engine),
        m_runControl(0),
223
        m_isActive(false),
224 225
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
226
        m_lastGoodState(DebuggerNotReady),
227 228 229 230 231 232 233 234 235
        m_breakHandler(engine),
        m_commandHandler(engine),
        m_modulesHandler(engine),
        m_registerHandler(engine),
        m_sourceFilesHandler(engine),
        m_stackHandler(engine),
        m_threadsHandler(engine),
        m_watchHandler(engine),
        m_disassemblerViewAgent(engine)
236
    {}
237 238

    ~DebuggerEnginePrivate() {}
239

240 241 242 243 244
public slots:
    void breakpointSetRemoveMarginActionTriggered();
    void breakpointEnableDisableMarginActionTriggered();
    void handleContextMenuRequest(const QVariant &parameters);

hjk's avatar
hjk committed
245 246
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
247 248
    void doShutdownEngine();
    void doShutdownInferior();
249
    void doInterruptInferior();
hjk's avatar
hjk committed
250
    void doFinishDebugger();
hjk's avatar
hjk committed
251

hjk's avatar
hjk committed
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
    void queueRunEngine() {
        m_engine->setState(EngineRunRequested);
        m_engine->showMessage(_("QUEUE: RUN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doRunEngine()));
    }

    void queueShutdownEngine() {
        m_engine->setState(EngineShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doShutdownEngine()));
    }

    void queueShutdownInferior() {
        m_engine->setState(InferiorShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doShutdownInferior()));
    }

    void queueFinishDebugger() {
271 272 273 274
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
275 276 277
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

278 279 280 281 282
    void raiseApplication() {
        m_runControl->bringApplicationToForeground(m_inferiorPid);
    }


283
public:
hjk's avatar
hjk committed
284 285
    DebuggerState state() const { return m_state; }

286 287
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.
288
    bool m_isActive;
289 290

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
291 292

    // The current state.
293 294
    DebuggerState m_state;

hjk's avatar
hjk committed
295 296 297 298 299 300
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

301 302 303 304 305 306 307 308 309 310 311
    qint64 m_inferiorPid;

    BreakHandler m_breakHandler;
    CommandHandler m_commandHandler;
    ModulesHandler m_modulesHandler;
    RegisterHandler m_registerHandler;
    SourceFilesHandler m_sourceFilesHandler;
    StackHandler m_stackHandler;
    ThreadsHandler m_threadsHandler;
    WatchHandler m_watchHandler;
    DisassemblerViewAgent m_disassemblerViewAgent;
312
    QFutureInterface<void> m_progress;
313 314
};

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
void DebuggerEnginePrivate::breakpointSetRemoveMarginActionTriggered()
{
    QAction *act = qobject_cast<QAction *>(sender());
    QTC_ASSERT(act, return);
    QList<QVariant> list = act->data().toList();
    QTC_ASSERT(list.size() == 2, return);
    const QString fileName = list.at(0).toString();
    const int lineNumber = list.at(1).toInt();
    m_breakHandler.toggleBreakpoint(fileName, lineNumber);
}

void DebuggerEnginePrivate::breakpointEnableDisableMarginActionTriggered()
{
    QAction *act = qobject_cast<QAction *>(sender());
    QTC_ASSERT(act, return);
    QList<QVariant> list = act->data().toList();
    QTC_ASSERT(list.size() == 2, return);
    const QString fileName = list.at(0).toString();
    const int lineNumber = list.at(1).toInt();
    m_breakHandler.toggleBreakpointEnabled(fileName, lineNumber);
}

void DebuggerEnginePrivate::handleContextMenuRequest(const QVariant &parameters)
{
    const QList<QVariant> list = parameters.toList();
    QTC_ASSERT(list.size() == 3, return);
hjk's avatar
hjk committed
341
    TextEditor::ITextEditor *editor =
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
        (TextEditor::ITextEditor *)(list.at(0).value<quint64>());
    int lineNumber = list.at(1).toInt();
    QMenu *menu = (QMenu *)(list.at(2).value<quint64>());

    BreakpointData *data = 0;
    QString position;
    QString fileName;
    if (editor->property("DisassemblerView").toBool()) {
        fileName = editor->file()->fileName();
        QString line = editor->contents()
            .section('\n', lineNumber - 1, lineNumber - 1);
        position = _("*") + fileName;
        BreakpointData needle;
        needle.bpAddress = line.left(line.indexOf(QLatin1Char(' '))).toLatin1();
        needle.bpLineNumber = "-1";
        data = m_breakHandler.findSimilarBreakpoint(&needle);
    } else {
        fileName = editor->file()->fileName();
        position = fileName + QString(":%1").arg(lineNumber);
        data = m_breakHandler.findBreakpoint(fileName, lineNumber);
    }

    QList<QVariant> args;
    args.append(fileName);
    args.append(lineNumber);

    if (data) {
        // existing breakpoint
        QAction *act = new QAction(tr("Remove Breakpoint"), menu);
        act->setData(args);
        connect(act, SIGNAL(triggered()),
            this, SLOT(breakpointSetRemoveMarginActionTriggered()));
        menu->addAction(act);

        QAction *act2;
        if (data->enabled)
            act2 = new QAction(tr("Disable Breakpoint"), menu);
        else
            act2 = new QAction(tr("Enable Breakpoint"), menu);
        act2->setData(args);
        connect(act2, SIGNAL(triggered()),
            this, SLOT(breakpointEnableDisableMarginActionTriggered()));
        menu->addAction(act2);
    } else {
        // non-existing
        QAction *act = new QAction(tr("Set Breakpoint"), menu);
        act->setData(args);
        connect(act, SIGNAL(triggered()),
            this, SLOT(breakpointSetRemoveMarginActionTriggered()));
        menu->addAction(act);
    }
}
394 395 396 397 398 399 400 401 402 403 404 405 406 407

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

DebuggerEngine::DebuggerEngine(const DebuggerStartParameters &startParameters)
  : d(new DebuggerEnginePrivate(this, startParameters))
{
}

DebuggerEngine::~DebuggerEngine()
{
408 409
    disconnect();
    delete d;
410 411
}

412
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
413
{
414
    showMessage(msg, StatusBar, timeout);
415
}
416 417 418 419 420 421 422 423 424 425 426 427 428 429

void DebuggerEngine::handleCommand(int role, const QVariant &value)
{
    //qDebug() << "COMMAND: " << role << value;

    switch (role) {
        case RequestReloadSourceFilesRole:
            reloadSourceFiles();
            break;

        case RequestReloadModulesRole:
            reloadModules();
            break;

430 431 432 433
        case RequestReloadRegistersRole:
            reloadRegisters();
            break;

434 435 436 437
        case RequestExecDetachRole:
            detachDebugger();
            break;

438 439 440 441 442
        case RequestExecContinueRole:
            continueInferior();
            break;

        case RequestExecInterruptRole:
443
            requestInterruptInferior();
444 445 446
            break;

        case RequestExecResetRole:
447
            notifyEngineIll(); // FIXME: check
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
            break;

        case RequestExecStepRole:
            executeStepX();
            break;

        case RequestExecStepOutRole:
            executeStepOutX();
            break;

        case RequestExecNextRole:
            executeStepNextX();
            break;

        case RequestExecRunToLineRole:
hjk's avatar
hjk committed
463
            executeRunToLine();
464 465 466
            break;

        case RequestExecRunToFunctionRole:
hjk's avatar
hjk committed
467
            executeRunToFunction();
468 469 470 471 472 473 474
            break;

        case RequestExecReturnFromFunctionRole:
            executeReturnX();
            break;

        case RequestExecJumpToLineRole:
hjk's avatar
hjk committed
475
            executeJumpToLine();
476 477 478
            break;

        case RequestExecWatchRole:
hjk's avatar
hjk committed
479
            addToWatchWindow();
480 481 482
            break;

        case RequestExecExitRole:
483
            d->queueShutdownInferior();
484 485
            break;

486 487
        case RequestCreateSnapshotRole:
            createSnapshot();
488 489
            break;

490 491 492 493
        case RequestActivationRole:
            setActive(value.toBool());
            break;

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
        case RequestExecFrameDownRole:
            frameDown();
            break;

        case RequestExecFrameUpRole:
            frameUp();
            break;

        case RequestOperatedByInstructionTriggeredRole:
            gotoLocation(stackHandler()->currentFrame(), true);
            break;

        case RequestExecuteCommandRole:
            executeDebuggerCommand(value.toString());
            break;
hjk's avatar
hjk committed
509

510 511 512 513 514 515 516 517 518
        case RequestToggleBreakpointRole: {
            QList<QVariant> list = value.toList();
            QTC_ASSERT(list.size() == 2, break);
            const QString fileName = list.at(0).toString();
            const int lineNumber = list.at(1).toInt();
            breakHandler()->toggleBreakpoint(fileName, lineNumber);
            break;
        }

519 520 521
        case RequestToolTipByExpressionRole: {
            QList<QVariant> list = value.toList();
            QTC_ASSERT(list.size() == 3, break);
522 523 524
            QPoint point = list.at(0).value<QPoint>();
            TextEditor::ITextEditor *editor = // Eeks.
                (TextEditor::ITextEditor *)(list.at(1).value<quint64>());
hjk's avatar
hjk committed
525
            int pos = list.at(2).toInt();
526
            setToolTipExpression(point, editor, pos);
527 528 529
            break;
        }

530
        case RequestContextMenuRole: {
531
            QList<QVariant> list = value.toList();
532 533
            QTC_ASSERT(list.size() == 3, break);
            d->handleContextMenuRequest(list);
hjk's avatar
hjk committed
534
            break;
535
        }
536
    }
537
}
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600

void DebuggerEngine::showModuleSymbols
    (const QString &moduleName, const Symbols &symbols)
{
    QTreeWidget *w = new QTreeWidget;
    w->setColumnCount(3);
    w->setRootIsDecorated(false);
    w->setAlternatingRowColors(true);
    w->setSortingEnabled(true);
    w->setHeaderLabels(QStringList() << tr("Symbol") << tr("Address") << tr("Code"));
    w->setWindowTitle(tr("Symbols in \"%1\"").arg(moduleName));
    foreach (const Symbol &s, symbols) {
        QTreeWidgetItem *it = new QTreeWidgetItem;
        it->setData(0, Qt::DisplayRole, s.name);
        it->setData(1, Qt::DisplayRole, s.address);
        it->setData(2, Qt::DisplayRole, s.state);
        w->addTopLevelItem(it);
    }
    plugin()->createNewDock(w);
}

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
{
    return &d->m_modulesHandler;
}

BreakHandler *DebuggerEngine::breakHandler() const
{
    return &d->m_breakHandler;
}

RegisterHandler *DebuggerEngine::registerHandler() const
{
    return &d->m_registerHandler;
}

StackHandler *DebuggerEngine::stackHandler() const
{
    return &d->m_stackHandler;
}

ThreadsHandler *DebuggerEngine::threadsHandler() const
{
    return &d->m_threadsHandler;
}

WatchHandler *DebuggerEngine::watchHandler() const
{
    return &d->m_watchHandler;
}

601 602 603 604
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
605 606 607 608 609 610 611 612 613 614 615 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 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675

SourceFilesHandler *DebuggerEngine::sourceFilesHandler() const
{
    return &d->m_sourceFilesHandler;
}

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
    return d->m_modulesHandler.model();
}

QAbstractItemModel *DebuggerEngine::breakModel() const
{
    return d->m_breakHandler.model();
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
    return d->m_registerHandler.model();
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
    return d->m_stackHandler.model();
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
    return d->m_threadsHandler.model();
}

QAbstractItemModel *DebuggerEngine::localsModel() const
{
    return d->m_watchHandler.model(LocalsWatch);
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
    return d->m_watchHandler.model(WatchersWatch);
}

QAbstractItemModel *DebuggerEngine::returnModel() const
{
    return d->m_watchHandler.model(ReturnWatch);
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
    return d->m_sourceFilesHandler.model();
}

QAbstractItemModel *DebuggerEngine::commandModel() const
{
    return d->m_commandHandler.model();
}

void DebuggerEngine::fetchMemory(MemoryViewAgent *, QObject *,
        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
{
676 677
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
678 679 680 681 682 683
    d->m_runControl->showMessage(msg, channel);
    plugin()->showMessage(msg, channel, timeout);
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
hjk's avatar
hjk committed
684
    if (!isSessionEngine()) {
685 686 687 688 689 690 691
        d->m_progress.setProgressRange(0, 100);
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
        fp->setKeepOnFinish(false);
        d->m_progress.reportStarted();
    }
692 693
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
694 695

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
696 697
    QTC_ASSERT(sessionTemplate, notifyEngineSetupFailed(); return);
    QTC_ASSERT(sessionTemplate != this, notifyEngineSetupFailed(); return);
698 699

    breakHandler()->initializeFromTemplate(sessionTemplate->breakHandler());
700
    watchHandler()->initializeFromTemplate(sessionTemplate->watchHandler());
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716

    d->m_runControl = runControl;

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

    if (d->m_startParameters.environment.empty())
        d->m_startParameters.environment = Environment().toStringList();

    if (d->m_startParameters.breakAtMain)
        breakByFunctionMain();

    const unsigned engineCapabilities = debuggerCapabilities();
    theDebuggerAction(OperateByInstruction)
        ->setEnabled(engineCapabilities & DisassemblerCapability);

717 718
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
hjk's avatar
hjk committed
719
    setState(EngineSetupRequested);
720

721
    d->m_progress.setProgressValue(20);
hjk's avatar
hjk committed
722
    setupEngine();
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
}

void DebuggerEngine::breakByFunctionMain()
{
#ifdef Q_OS_WIN
    // FIXME: wrong on non-Qt based binaries
    emit breakByFunction("qMain");
#else
    emit breakByFunction("main");
#endif
}

void DebuggerEngine::breakByFunction(const QString &functionName)
{
    d->m_breakHandler.breakByFunction(functionName);
    attemptBreakpointSynchronization();
}

void DebuggerEngine::resetLocation()
{
    d->m_disassemblerViewAgent.resetLocation();
    d->m_stackHandler.setCurrentIndex(-1);
    plugin()->resetLocation();
}

void DebuggerEngine::gotoLocation(const QString &fileName, int lineNumber, bool setMarker)
{
    StackFrame frame;
    frame.file = fileName;
    frame.line = lineNumber;
    gotoLocation(frame, setMarker);
}

void DebuggerEngine::gotoLocation(const StackFrame &frame, bool setMarker)
{
    if (theDebuggerBoolSetting(OperateByInstruction) || !frame.isUsable()) {
        if (setMarker)
            plugin()->resetLocation();
        d->m_disassemblerViewAgent.setFrame(frame);
    } else {
        plugin()->gotoLocation(frame.file, frame.line, setMarker);
    }
}

void DebuggerEngine::executeStepX()
{
    resetLocation();
    if (theDebuggerBoolSetting(OperateByInstruction))
        executeStepI();
    else
        executeStep();
}

void DebuggerEngine::executeStepOutX()
{
    resetLocation();
    executeStepOut();
}

void DebuggerEngine::executeStepNextX()
{
    resetLocation();
    if (theDebuggerBoolSetting(OperateByInstruction))
        executeNextI();
    else
        executeNext();
}

void DebuggerEngine::executeReturnX()
{
    resetLocation();
    executeReturn();
}

hjk's avatar
hjk committed
797
static TextEditor::ITextEditor *currentTextEditor()
798
{
hjk's avatar
hjk committed
799 800 801 802 803
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return 0;
    Core::IEditor *editor = editorManager->currentEditor();
    return qobject_cast<ITextEditor*>(editor);
804 805
}

hjk's avatar
hjk committed
806
void DebuggerEngine::executeRunToLine()
807
{
hjk's avatar
hjk committed
808
    ITextEditor *textEditor = currentTextEditor();
809 810
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
hjk's avatar
hjk committed
811 812
    if (fileName.isEmpty())
        return;
813
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
814 815
    resetLocation();
    executeRunToLine(fileName, lineNumber);
816 817
}

hjk's avatar
hjk committed
818
void DebuggerEngine::executeRunToFunction()
819
{
hjk's avatar
hjk committed
820
    ITextEditor *textEditor = currentTextEditor();
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
    QPlainTextEdit *ed = qobject_cast<QPlainTextEdit*>(textEditor->widget());
    if (!ed)
        return;
    QTextCursor cursor = ed->textCursor();
    QString functionName = cursor.selectedText();
    if (functionName.isEmpty()) {
        const QTextBlock block = cursor.block();
        const QString line = block.text();
        foreach (const QString &str, line.trimmed().split('(')) {
            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;
            }
        }
    }

hjk's avatar
hjk committed
845 846 847 848
    if (functionName.isEmpty())
        return;
    resetLocation();
    executeRunToFunction(functionName);
849 850
}

hjk's avatar
hjk committed
851
void DebuggerEngine::executeJumpToLine()
852
{
hjk's avatar
hjk committed
853
    ITextEditor *textEditor = currentTextEditor();
854 855 856
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
857 858 859
    if (fileName.isEmpty())
        return;
    executeJumpToLine(fileName, lineNumber);
860 861
}

hjk's avatar
hjk committed
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
void DebuggerEngine::addToWatchWindow()
{
    // Requires a selection, but that's the only case we want anyway.
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return;
    IEditor *editor = editorManager->currentEditor();
    if (!editor)
        return;
    ITextEditor *textEditor = qobject_cast<ITextEditor*>(editor);
    if (!textEditor)
        return;
    QTextCursor tc;
    QPlainTextEdit *ptEdit = qobject_cast<QPlainTextEdit*>(editor->widget());
    if (ptEdit)
        tc = ptEdit->textCursor();
    QString exp;
    if (tc.hasSelection()) {
        exp = tc.selectedText();
    } else {
        int line, column;
        exp = cppExpressionAt(textEditor, tc.position(), &line, &column);
    }
885 886 887
    if (exp.isEmpty())
        return;
    watchHandler()->watchExpression(exp);
hjk's avatar
hjk committed
888 889
}

890 891 892 893
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
    d->m_runControl = 0;
894 895 896 897

    d->m_progress.setProgressValue(90);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
898 899
}

900 901
// Called from RunControl.
void DebuggerEngine::handleFinished()
902
{
903
    d->m_runControl = 0;
904 905 906 907
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
908 909

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
910 911
    QTC_ASSERT(sessionTemplate != this, /**/);
    breakHandler()->storeToTemplate(sessionTemplate->breakHandler());
912
    watchHandler()->storeToTemplate(sessionTemplate->watchHandler());
913 914 915

    d->m_progress.setProgressValue(100);
    d->m_progress.reportFinished();
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
}

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
{
    return theDebuggerBoolSetting(UseDebuggingHelpers);
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
    if (theDebuggerAction(UseCustomDebuggingHelperLocation)->value().toBool()) {
        const QString customLocation =
            theDebuggerAction(CustomDebuggingHelperLocation)->value().toString();
        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)
{
    //QMessageBox dialog(d->m_mainWindow); // FIXME
    QMessageBox dialog;
    QPushButton *qtPref = dialog.addButton(tr("Open Qt preferences"),
        QMessageBox::ActionRole);
    QPushButton *helperOff = dialog.addButton(tr("Turn off helper usage"),
        QMessageBox::ActionRole);
    QPushButton *justContinue = dialog.addButton(tr("Continue anyway"),
        QMessageBox::AcceptRole);
    dialog.setDefaultButton(justContinue);
    dialog.setWindowTitle(tr("Debugging helper missing"));
    dialog.setText(tr("The debugger could not load the debugging helper library."));
    dialog.setInformativeText(tr(
        "The debugging helper is used to nicely format the values of some Qt "
        "and Standard Library data types. "
        "It must be compiled for each used Qt version separately. "
        "This can be done in the Qt preferences page by selecting a Qt installation "
        "and clicking on 'Rebuild' in the 'Debugging Helper' row."));
    if (!details.isEmpty())
        dialog.setDetailedText(details);
    dialog.exec();
    if (dialog.clickedButton() == qtPref) {
        Core::ICore::instance()->showOptionsDialog(
            _(Qt4ProjectManager::Constants::QT_SETTINGS_CATEGORY),
            _(Qt4ProjectManager::Constants::QTVERSION_SETTINGS_PAGE_ID));
    } else if (dialog.clickedButton() == helperOff) {
        theDebuggerAction(UseDebuggingHelpers)
            ->setValue(qVariantFromValue(false), false);
    }
}

QString DebuggerEngine::qtDumperLibraryName() const
{
    if (theDebuggerAction(UseCustomDebuggingHelperLocation)->value().toBool())
        return theDebuggerAction(CustomDebuggingHelperLocation)->value().toString();
    return startParameters().dumperLibrary;
}

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

hjk's avatar
hjk committed
999
DebuggerState DebuggerEngine::lastGoodState() const
1000
{
hjk's avatar
hjk committed
1001 1002 1003 1004 1005 1006 1007
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
1009 1010 1011
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
1012
    case DebuggerNotReady:
1013
        return to == EngineSetupRequested;
1014

hjk's avatar
hjk committed
1015
    case EngineSetupRequested:
1016 1017
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
1018
        // FIXME: In therory it's the engine's task to go into a
1019 1020 1021
        // proper "Shutdown" state before calling notifyEngineSetupFailed
        //return to == DebuggerFinished;
        return to == EngineShutdownRequested;
1022
    case EngineSetupOk:
hjk's avatar
hjk committed
1023
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
1024

hjk's avatar
hjk committed
1025 1026
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
1027
    case InferiorSetupFailed:
hjk's avatar
hjk committed
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
        return to == EngineShutdownRequested;

    case EngineRunRequested:
        return to == InferiorRunRequested || to == InferiorStopRequested
            || to == InferiorUnrunnable || to == EngineRunFailed;

    case EngineRunFailed:
        return to == InferiorShutdownRequested;

    case InferiorRunRequested:
        return to == InferiorRunOk || to == InferiorRunFailed;
    case InferiorRunFailed:
        return to == InferiorStopOk;
    case InferiorRunOk:
        return to == InferiorStopRequested || to == InferiorStopOk;

    case InferiorStopRequested:
        return to == InferiorStopOk || to == InferiorStopFailed;
    case InferiorStopOk:
        return to == InferiorRunRequested || to == InferiorShutdownRequested
            || to == InferiorStopOk;
1049
    case InferiorStopFailed:
hjk's avatar
hjk committed
1050
        return to == EngineShutdownRequested;
1051 1052

    case InferiorUnrunnable:
hjk's avatar
hjk committed
1053 1054 1055 1056 1057
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
1058
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
1059
        return to == EngineShutdownRequested;
1060

hjk's avatar
hjk committed
1061 1062 1063 1064 1065 1066 1067 1068
    case EngineShutdownRequested:
        return to == EngineShutdownOk;
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
1069
        return to == EngineSetupRequested; // Happens on restart.
1070 1071 1072 1073 1074 1075
    }

    qDebug() << "UNKNOWN STATE:" << from;
    return false;
}

1076
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
1077
{
hjk's avatar
hjk committed
1078
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
1079
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
1080
    setState(EngineSetupFailed);
1081 1082 1083
    QTC_ASSERT(d->m_runControl, /**/);
    if (d->m_runControl)
        d->m_runControl->startFailed();
hjk's avatar
hjk committed
1084
    d->queueShutdownEngine();
hjk's avatar
hjk committed
1085 1086
}

1087
void DebuggerEngine::notifyEngineSetupOk()
1088
{
hjk's avatar
hjk committed
1089
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
1090
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
1091
    setState(EngineSetupOk);
1092
    QTC_ASSERT(d->m_runControl, /**/);
1093 1094 1095
    if (d->m_runControl) {
        d->m_progress.setProgressValue(100);
        d->m_progress.reportFinished();
1096
        d->m_runControl->startSuccessful();
1097
    }
hjk's avatar
hjk committed
1098
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
1099
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
1100 1101
}

hjk's avatar
hjk committed
1102
void DebuggerEnginePrivate::doSetupInferior()
1103
{
1104
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
1105
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
1106
    m_progress.setProgressValue(25);
hjk's avatar
hjk committed
1107
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
1108 1109 1110 1111 1112
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
1113
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
1114
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
1115
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
1116
    d->queueShutdownEngine();
hjk's avatar
hjk committed
1117 1118 1119 1120
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
1121
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
1122
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
1123
    d->queueRunEngine();
hjk's avatar
hjk committed
1124 1125 1126 1127
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
1128
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
1129
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
1130
    m_progress.setProgressValue(30);
hjk's avatar
hjk committed
1131 1132 1133
    m_engine->runEngine();
}

hjk's avatar
hjk committed
1134 1135
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
1136
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
hjk's avatar
hjk committed
1137 1138 1139 1140 1141 1142
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
1143
    showMessage(_("NOTE: ENGINE RUN FAILED"));
hjk's avatar
hjk committed
1144 1145
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(EngineRunFailed);
hjk's avatar
hjk committed
1146
    d->queueShutdownInferior();
hjk's avatar
hjk committed
1147 1148 1149 1150
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
1151
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
hjk's avatar
hjk committed
1152 1153 1154 1155 1156 1157 1158
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorRunRequested);
    notifyInferiorRunOk();
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
1159
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
hjk's avatar
hjk committed
1160 1161 1162 1163 1164 1165 1166
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorStopRequested);
    notifyInferiorStopOk();
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
1167
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
hjk's avatar
hjk committed
1168 1169 1170 1171 1172 1173
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
1174
    showMessage(_("NOTE: INFERIOR RUN OK"));
hjk's avatar
hjk committed
1175 1176 1177 1178 1179 1180
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
1181
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
hjk's avatar
hjk committed
1182 1183 1184
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
1185 1186
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
1187 1188 1189 1190
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
1191 1192
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
1193
    if (isDying()) {
hjk's avatar
hjk committed
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
        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
1207
    }
hjk's avatar
hjk committed
1208 1209
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopOk);
hjk's avatar
hjk committed
1210 1211
}

hjk's avatar
hjk committed
1212
void DebuggerEngine::notifyInferiorSpontaneousStop()
1213
{
hjk's avatar
hjk committed
1214
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
hjk's avatar
hjk committed
1215 1216
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    setState(InferiorStopOk);