debuggerengine.cpp 41.5 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 51
#include <coreplugin/icore.h>
#include <coreplugin/editormanager/editormanager.h>

52 53 54 55 56 57 58 59 60 61
#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
62 63
#include <texteditor/itexteditor.h>

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

#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QTimer>

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


hjk's avatar
hjk committed
85
using namespace Core;
86 87
using namespace Debugger;
using namespace Debugger::Internal;
hjk's avatar
hjk committed
88 89
using namespace ProjectExplorer;
using namespace TextEditor;
90

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

///////////////////////////////////////////////////////////////////////
//
// 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
123 124
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
125 126 127 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
}

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
154
        SN(EngineSetupRequested)
155 156
        SN(EngineSetupOk)
        SN(EngineSetupFailed)
hjk's avatar
hjk committed
157 158
        SN(EngineRunFailed)
        SN(InferiorSetupRequested)
hjk's avatar
hjk committed
159
        SN(InferiorSetupFailed)
hjk's avatar
hjk committed
160 161 162 163
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
164
        SN(InferiorUnrunnable)
hjk's avatar
hjk committed
165 166
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
167
        SN(InferiorStopFailed)
hjk's avatar
hjk committed
168 169
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
170
        SN(InferiorShutdownFailed)
hjk's avatar
hjk committed
171 172 173 174
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
175 176 177 178 179
    }
    return "<unknown>";
#    undef SN
}

180

181 182 183 184 185 186 187 188 189
//////////////////////////////////////////////////////////////////////
//
// CommandHandler
//
//////////////////////////////////////////////////////////////////////

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

private:
195
    QPointer<DebuggerEngine> m_engine;
196 197
};

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


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

212
class DebuggerEnginePrivate : public QObject
213
{
214 215
    Q_OBJECT

216 217 218 219
public:
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
      : m_engine(engine),
        m_runControl(0),
220
        m_isActive(false),
221 222
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
223
        m_lastGoodState(DebuggerNotReady),
224 225 226 227 228 229 230 231 232 233 234
        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)
    {}

235 236 237 238 239
public slots:
    void breakpointSetRemoveMarginActionTriggered();
    void breakpointEnableDisableMarginActionTriggered();
    void handleContextMenuRequest(const QVariant &parameters);

hjk's avatar
hjk committed
240 241
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
242 243
    void doShutdownEngine();
    void doShutdownInferior();
244
    void doInterruptInferior();
hjk's avatar
hjk committed
245
    void doFinishDebugger();
hjk's avatar
hjk committed
246

hjk's avatar
hjk committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
    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() {
266 267 268 269
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
270 271 272
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

273 274 275 276 277
    void raiseApplication() {
        m_runControl->bringApplicationToForeground(m_inferiorPid);
    }


278
public:
hjk's avatar
hjk committed
279 280
    DebuggerState state() const { return m_state; }

281 282
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.
283
    bool m_isActive;
284 285

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
286 287

    // The current state.
288 289
    DebuggerState m_state;

hjk's avatar
hjk committed
290 291 292 293 294 295
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

296 297 298 299 300 301 302 303 304 305 306 307 308
    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;
};

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
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
335
    TextEditor::ITextEditor *editor =
336 337 338 339 340 341 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
        (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);
    }
}
388 389 390 391 392 393 394 395 396 397 398 399 400 401

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

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

DebuggerEngine::~DebuggerEngine()
{
402 403
    disconnect();
    delete d;
404 405
}

406
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
407
{
408
    showMessage(msg, StatusBar, timeout);
409
}
410 411 412 413 414 415 416 417 418 419 420 421 422 423

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

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

        case RequestReloadModulesRole:
            reloadModules();
            break;

424 425 426 427
        case RequestReloadRegistersRole:
            reloadRegisters();
            break;

428 429 430 431
        case RequestExecDetachRole:
            detachDebugger();
            break;

432 433 434 435 436
        case RequestExecContinueRole:
            continueInferior();
            break;

        case RequestExecInterruptRole:
437
            requestInterruptInferior();
438 439 440
            break;

        case RequestExecResetRole:
441
            notifyEngineIll(); // FIXME: check
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
            break;

        case RequestExecStepRole:
            executeStepX();
            break;

        case RequestExecStepOutRole:
            executeStepOutX();
            break;

        case RequestExecNextRole:
            executeStepNextX();
            break;

        case RequestExecRunToLineRole:
hjk's avatar
hjk committed
457
            executeRunToLine();
458 459 460
            break;

        case RequestExecRunToFunctionRole:
hjk's avatar
hjk committed
461
            executeRunToFunction();
462 463 464 465 466 467 468
            break;

        case RequestExecReturnFromFunctionRole:
            executeReturnX();
            break;

        case RequestExecJumpToLineRole:
hjk's avatar
hjk committed
469
            executeJumpToLine();
470 471 472
            break;

        case RequestExecWatchRole:
hjk's avatar
hjk committed
473
            addToWatchWindow();
474 475 476
            break;

        case RequestExecExitRole:
477
            d->queueShutdownInferior();
478 479
            break;

480 481
        case RequestCreateSnapshotRole:
            createSnapshot();
482 483
            break;

484 485 486 487
        case RequestActivationRole:
            setActive(value.toBool());
            break;

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
        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
503

504 505 506 507 508 509 510 511 512
        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;
        }

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

524
        case RequestContextMenuRole: {
525
            QList<QVariant> list = value.toList();
526 527
            QTC_ASSERT(list.size() == 3, break);
            d->handleContextMenuRequest(list);
hjk's avatar
hjk committed
528
            break;
529
        }
530
    }
531
}
532 533 534 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

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;
}

595 596 597 598
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
599 600 601 602 603 604 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

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
{
670 671
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
672 673 674 675 676 677
    d->m_runControl->showMessage(msg, channel);
    plugin()->showMessage(msg, channel, timeout);
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
678 679
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
680 681

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
682 683
    QTC_ASSERT(sessionTemplate, notifyEngineSetupFailed(); return);
    QTC_ASSERT(sessionTemplate != this, notifyEngineSetupFailed(); return);
684 685

    breakHandler()->initializeFromTemplate(sessionTemplate->breakHandler());
686
    watchHandler()->initializeFromTemplate(sessionTemplate->watchHandler());
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702

    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);

703 704
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
hjk's avatar
hjk committed
705
    setState(EngineSetupRequested);
706

hjk's avatar
hjk committed
707
    setupEngine();
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 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
}

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
782
static TextEditor::ITextEditor *currentTextEditor()
783
{
hjk's avatar
hjk committed
784 785 786 787 788
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return 0;
    Core::IEditor *editor = editorManager->currentEditor();
    return qobject_cast<ITextEditor*>(editor);
789 790
}

hjk's avatar
hjk committed
791
void DebuggerEngine::executeRunToLine()
792
{
hjk's avatar
hjk committed
793
    ITextEditor *textEditor = currentTextEditor();
794 795
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
hjk's avatar
hjk committed
796 797
    if (fileName.isEmpty())
        return;
798
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
799 800
    resetLocation();
    executeRunToLine(fileName, lineNumber);
801 802
}

hjk's avatar
hjk committed
803
void DebuggerEngine::executeRunToFunction()
804
{
hjk's avatar
hjk committed
805
    ITextEditor *textEditor = currentTextEditor();
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
    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
830 831 832 833
    if (functionName.isEmpty())
        return;
    resetLocation();
    executeRunToFunction(functionName);
834 835
}

hjk's avatar
hjk committed
836
void DebuggerEngine::executeJumpToLine()
837
{
hjk's avatar
hjk committed
838
    ITextEditor *textEditor = currentTextEditor();
839 840 841
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
842 843 844
    if (fileName.isEmpty())
        return;
    executeJumpToLine(fileName, lineNumber);
845 846
}

hjk's avatar
hjk committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
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);
    }
870 871 872
    if (exp.isEmpty())
        return;
    watchHandler()->watchExpression(exp);
hjk's avatar
hjk committed
873 874
}

875 876 877 878 879 880
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
    d->m_runControl = 0;
}

881 882
// Called from RunControl.
void DebuggerEngine::handleFinished()
883
{
884
    d->m_runControl = 0;
885 886 887 888
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
889 890

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
891 892
    QTC_ASSERT(sessionTemplate != this, /**/);
    breakHandler()->storeToTemplate(sessionTemplate->breakHandler());
893
    watchHandler()->storeToTemplate(sessionTemplate->watchHandler());
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 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
}

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
977
DebuggerState DebuggerEngine::lastGoodState() const
978
{
hjk's avatar
hjk committed
979 980 981 982 983 984 985
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
987 988 989
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
990
    case DebuggerNotReady:
991
        return to == EngineSetupRequested;
992

hjk's avatar
hjk committed
993
    case EngineSetupRequested:
994 995
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
996
        // FIXME: In therory it's the engine's task to go into a
997 998 999
        // proper "Shutdown" state before calling notifyEngineSetupFailed
        //return to == DebuggerFinished;
        return to == EngineShutdownRequested;
1000
    case EngineSetupOk:
hjk's avatar
hjk committed
1001
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
1002

hjk's avatar
hjk committed
1003 1004
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
1005
    case InferiorSetupFailed:
hjk's avatar
hjk committed
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
        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;
1027
    case InferiorStopFailed:
hjk's avatar
hjk committed
1028
        return to == EngineShutdownRequested;
1029 1030

    case InferiorUnrunnable:
hjk's avatar
hjk committed
1031 1032 1033 1034 1035
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
1036
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
1037
        return to == EngineShutdownRequested;
1038

hjk's avatar
hjk committed
1039 1040 1041 1042 1043 1044 1045 1046
    case EngineShutdownRequested:
        return to == EngineShutdownOk;
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
1047
        return to == EngineSetupRequested; // Happens on restart.
1048 1049 1050 1051 1052 1053
    }

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

1054
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
1055
{
hjk's avatar
hjk committed
1056
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
1057
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
1058
    setState(EngineSetupFailed);
1059 1060 1061
    QTC_ASSERT(d->m_runControl, /**/);
    if (d->m_runControl)
        d->m_runControl->startFailed();
hjk's avatar
hjk committed
1062
    d->queueShutdownEngine();
hjk's avatar
hjk committed
1063 1064
}

1065
void DebuggerEngine::notifyEngineSetupOk()
1066
{
hjk's avatar
hjk committed
1067
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
1068
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
1069
    setState(EngineSetupOk);
1070 1071 1072
    QTC_ASSERT(d->m_runControl, /**/);
    if (d->m_runControl)
        d->m_runControl->startSuccessful();
hjk's avatar
hjk committed
1073
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
1074
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
1075 1076
}

hjk's avatar
hjk committed
1077
void DebuggerEnginePrivate::doSetupInferior()
1078
{
hjk's avatar
hjk committed
1079 1080
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
1081
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
1082 1083 1084 1085 1086
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
1087
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
1088
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
1089
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
1090
    d->queueShutdownEngine();
hjk's avatar
hjk committed
1091 1092 1093 1094
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
1095
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
1096
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
1097
    d->queueRunEngine();
hjk's avatar
hjk committed
1098 1099 1100 1101
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
1102
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
1103
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
hjk's avatar
hjk committed
1104 1105 1106
    m_engine->runEngine();
}

hjk's avatar
hjk committed
1107 1108
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
1109
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
hjk's avatar
hjk committed
1110 1111 1112 1113 1114 1115
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
1116
    showMessage(_("NOTE: ENGINE RUN FAILED"));
hjk's avatar
hjk committed
1117 1118
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(EngineRunFailed);
hjk's avatar
hjk committed
1119
    d->queueShutdownInferior();
hjk's avatar
hjk committed
1120 1121 1122 1123
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
1124
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
hjk's avatar
hjk committed
1125 1126 1127 1128 1129 1130 1131
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorRunRequested);
    notifyInferiorRunOk();
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
1132
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
hjk's avatar
hjk committed
1133 1134 1135 1136 1137 1138 1139
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorStopRequested);
    notifyInferiorStopOk();
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
1140
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
hjk's avatar
hjk committed
1141 1142 1143 1144 1145 1146
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
1147
    showMessage(_("NOTE: INFERIOR RUN OK"));
hjk's avatar
hjk committed
1148 1149 1150 1151 1152 1153
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
1154
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
hjk's avatar
hjk committed
1155 1156 1157
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
1158 1159
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
1160 1161 1162 1163
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
1164 1165
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
1166
    if (isDying()) {
hjk's avatar
hjk committed
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
        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
1180
    }
hjk's avatar
hjk committed
1181 1182
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopOk);
hjk's avatar
hjk committed
1183 1184
}

hjk's avatar
hjk committed
1185
void DebuggerEngine::notifyInferiorSpontaneousStop()
1186
{
hjk's avatar
hjk committed
1187
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
hjk's avatar
hjk committed
1188 1189
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    setState(InferiorStopOk);
1190 1191
}

hjk's avatar
hjk committed
1192
void DebuggerEngine::notifyInferiorStopFailed()
1193
{
hjk's avatar
hjk committed
1194
    showMessage(_("NOTE: INFERIOR STOP FAILED"));
hjk's avatar
hjk committed
1195 1196
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopFailed);
hjk's avatar
hjk committed
1197
    d->queueShutdownEngine();
1198 1199 1200 1201
}

void DebuggerEnginePrivate::doInterruptInferior()
{
hjk's avatar
hjk committed
1202 1203
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    m_engine->setState(InferiorStopRequested);
hjk's avatar
hjk committed
1204
    m_engine->showMessage(_("CALL: INTERRUPT INFERIOR"));
1205 1206 1207
    m_engine->interruptInferior();
}

hjk's avatar
hjk committed
1208 1209
void DebuggerEnginePrivate::doShutdownInferior()
{
1210
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
1211 1212
    m_engine->resetLocation();
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
1213
    m_engine->showMessage(_("CALL: SHUTDOWN INFERIOR"));
hjk's avatar
hjk committed
1214 1215 1216 1217 1218 1219
    m_engine->shutdownInferior();
}

void DebuggerEngine::notifyInferiorShutdownOk()
{
    showMessage(_("INFERIOR SUCCESSFULLY SHUT DOWN"));
hjk's avatar
hjk committed
1220
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
1221 1222
    d->m_lastGoodState = DebuggerNotReady; // A "neutral" value.
    setState(InferiorShutdownOk);
hjk's avatar
hjk committed
1223
    d->queueShutdownEngine();
hjk's avatar
hjk committed
1224 1225 1226 1227 1228
}

void DebuggerEngine::notifyInferiorShutdownFailed()
{
    showMessage(_(