debuggerengine.cpp 49.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
/**************************************************************************
**
** 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 "debuggerplugin.h"
#include "debuggerstringutils.h"
37
#include "debuggertooltip.h"
38
#include "logwindow.h"
39 40 41 42 43 44 45 46 47

#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
48
#include "watchutils.h"
49
#include "breakwindow.h"
50

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

56 57 58 59 60 61 62 63 64
#include <projectexplorer/debugginghelper.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
65 66
#include <texteditor/itexteditor.h>

67
#include <utils/environment.h>
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>
75
#include <QtCore/QFutureInterface>
76 77 78 79

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

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

hjk's avatar
hjk committed
96 97 98 99 100 101 102
//#define DEBUG_STATE 1
#if DEBUG_STATE
#   define SDEBUG(s) qDebug() << s
#else
#   define SDEBUG(s)
#endif
# define XSDEBUG(s) qDebug() << s
103 104 105 106 107 108 109

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

110
DebuggerStartParameters::DebuggerStartParameters() :
111
    isSnapshot(false),
112 113
    attachPID(-1),
    useTerminal(false),
114 115
    breakAtMain(false),
    qmlServerAddress("127.0.0.1"),
116
    qmlServerPort(0),
hjk's avatar
hjk committed
117
    useServerStartScript(false),
118
    connParams(SshConnectionParameters::NoProxy),
119 120 121
    toolChainType(ToolChain::UNKNOWN),
    startMode(NoStartMode),
    executableUid(0)
122 123 124 125 126 127 128 129 130 131 132 133
{}

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


namespace Debugger {

QDebug operator<<(QDebug d, DebuggerState state)
{
hjk's avatar
hjk committed
134 135
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
}

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
hjk's avatar
hjk committed
152
            << " useServerStartScript=" << sp.useServerStartScript
153 154 155 156 157 158 159 160 161 162
            << " serverStartScript=" << sp.serverStartScript
            << " toolchain=" << sp.toolChainType << '\n';
    return str;
}

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

189

190 191 192 193 194 195 196 197 198
//////////////////////////////////////////////////////////////////////
//
// CommandHandler
//
//////////////////////////////////////////////////////////////////////

class CommandHandler : public QStandardItemModel
{
public:
199
    explicit CommandHandler(DebuggerEngine *engine) : m_engine(engine) {}
200 201 202 203
    bool setData(const QModelIndex &index, const QVariant &value, int role);
    QAbstractItemModel *model() { return this; }

private:
204
    QPointer<DebuggerEngine> m_engine;
205 206
};

207
bool CommandHandler::setData(const QModelIndex &, const QVariant &value, int role)
208
{
209
    QTC_ASSERT(m_engine, qDebug() << value << role; return false);
210 211
    m_engine->handleCommand(role, value);
    return true;
212 213 214 215 216 217 218 219 220
}


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

221
class DebuggerEnginePrivate : public QObject
222
{
223 224
    Q_OBJECT

225 226 227 228
public:
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
      : m_engine(engine),
        m_runControl(0),
229
        m_isActive(false),
230 231
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
232
        m_lastGoodState(DebuggerNotReady),
233 234 235 236 237 238 239 240
        m_breakHandler(engine),
        m_commandHandler(engine),
        m_modulesHandler(engine),
        m_registerHandler(engine),
        m_sourceFilesHandler(engine),
        m_stackHandler(engine),
        m_threadsHandler(engine),
        m_watchHandler(engine),
241 242
        m_disassemblerViewAgent(engine),
        m_runInWrapperEngine(false)
243
    {}
244 245

    ~DebuggerEnginePrivate() {}
246

247 248 249 250 251
public slots:
    void breakpointSetRemoveMarginActionTriggered();
    void breakpointEnableDisableMarginActionTriggered();
    void handleContextMenuRequest(const QVariant &parameters);

hjk's avatar
hjk committed
252 253
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
254 255
    void doShutdownEngine();
    void doShutdownInferior();
256
    void doInterruptInferior();
hjk's avatar
hjk committed
257
    void doFinishDebugger();
hjk's avatar
hjk committed
258

hjk's avatar
hjk committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
    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() {
278 279 280 281
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
282 283 284
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

285
    void raiseApplication() {
hjk's avatar
hjk committed
286
        QTC_ASSERT(m_runControl, return);
287 288 289
        m_runControl->bringApplicationToForeground(m_inferiorPid);
    }

290 291
private slots:
    void slotEditBreakpoint();
292

293
public:
hjk's avatar
hjk committed
294 295
    DebuggerState state() const { return m_state; }

296 297
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.
298
    bool m_isActive;
299 300

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
301 302

    // The current state.
303 304
    DebuggerState m_state;

hjk's avatar
hjk committed
305 306 307 308 309 310
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

311 312 313 314 315 316 317 318 319 320 321
    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;
322
    QFutureInterface<void> m_progress;
323 324

    bool m_runInWrapperEngine;
325 326
};

327 328 329 330 331
void DebuggerEnginePrivate::breakpointSetRemoveMarginActionTriggered()
{
    QAction *act = qobject_cast<QAction *>(sender());
    QTC_ASSERT(act, return);
    QList<QVariant> list = act->data().toList();
332
    QTC_ASSERT(list.size() >= 3, qDebug() << list; return);
333 334
    const QString fileName = list.at(0).toString();
    const int lineNumber = list.at(1).toInt();
335 336
    const quint64 address = list.at(2).toULongLong();
    m_breakHandler.toggleBreakpoint(fileName, lineNumber, address);
337 338
}

339 340 341 342 343 344 345 346 347 348 349
void DebuggerEnginePrivate::slotEditBreakpoint()
{
    const QAction *act = qobject_cast<QAction *>(sender());
    QTC_ASSERT(act, return);
    const QVariant data = act->data();
    QTC_ASSERT(qVariantCanConvert<BreakpointData *>(data), return);
    BreakpointData *breakPointData = qvariant_cast<BreakpointData *>(data);
    if (BreakWindow::editBreakpoint(breakPointData, ICore::instance()->mainWindow()))
        breakPointData->reinsertBreakpoint();
}

350 351 352 353 354
void DebuggerEnginePrivate::breakpointEnableDisableMarginActionTriggered()
{
    QAction *act = qobject_cast<QAction *>(sender());
    QTC_ASSERT(act, return);
    QList<QVariant> list = act->data().toList();
355
    QTC_ASSERT(list.size() == 3, qDebug() << list; return);
356 357 358 359 360 361 362 363
    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();
364
    QTC_ASSERT(list.size() == 3, qDebug() << list; return);
hjk's avatar
hjk committed
365
    TextEditor::ITextEditor *editor =
366 367 368 369 370 371
        (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 fileName;
372
    quint64 address = 0;
373 374 375 376 377
    if (editor->property("DisassemblerView").toBool()) {
        fileName = editor->file()->fileName();
        QString line = editor->contents()
            .section('\n', lineNumber - 1, lineNumber - 1);
        BreakpointData needle;
378 379
        address = needle.address = DisassemblerViewAgent::addressFromDisassemblyLine(line);
        needle.bpLineNumber = -1;
380 381 382 383 384 385 386 387 388
        data = m_breakHandler.findSimilarBreakpoint(&needle);
    } else {
        fileName = editor->file()->fileName();
        data = m_breakHandler.findBreakpoint(fileName, lineNumber);
    }

    QList<QVariant> args;
    args.append(fileName);
    args.append(lineNumber);
389
    args.append(address);
390 391 392

    if (data) {
        // existing breakpoint
393 394
        const QString number = QString::fromAscii(data->bpNumber);
        QAction *act = new QAction(tr("Remove Breakpoint %1").arg(number), menu);
395 396 397 398 399 400 401
        act->setData(args);
        connect(act, SIGNAL(triggered()),
            this, SLOT(breakpointSetRemoveMarginActionTriggered()));
        menu->addAction(act);

        QAction *act2;
        if (data->enabled)
402
            act2 = new QAction(tr("Disable Breakpoint %1").arg(number), menu);
403
        else
404
            act2 = new QAction(tr("Enable Breakpoint %1").arg(number), menu);
405 406 407 408
        act2->setData(args);
        connect(act2, SIGNAL(triggered()),
            this, SLOT(breakpointEnableDisableMarginActionTriggered()));
        menu->addAction(act2);
409 410 411 412
        QAction *editAction = new QAction(tr("Edit Breakpoint %1...").arg(number), menu);
        connect(editAction, SIGNAL(triggered()), this, SLOT(slotEditBreakpoint()));
        editAction->setData(qVariantFromValue(data));
        menu->addAction(editAction);
413 414
    } else {
        // non-existing
415 416 417 418
        const QString text = address ?
                    tr("Set Breakpoint at 0x%1").arg(address, 0, 16) :
                    tr("Set Breakpoint at line %1").arg(lineNumber);
        QAction *act = new QAction(text, menu);
419 420 421 422 423 424
        act->setData(args);
        connect(act, SIGNAL(triggered()),
            this, SLOT(breakpointSetRemoveMarginActionTriggered()));
        menu->addAction(act);
    }
}
425 426 427 428 429 430 431 432 433 434 435 436 437 438

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

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

DebuggerEngine::~DebuggerEngine()
{
439 440
    disconnect();
    delete d;
441 442
}

443
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
444
{
445
    showMessage(msg, StatusBar, timeout);
446
}
447

448 449 450 451 452 453
void DebuggerEngine::removeTooltip()
{
    watchHandler()->removeTooltip();
    hideDebuggerToolTip();
}

454 455
void DebuggerEngine::handleCommand(int role, const QVariant &value)
{
456 457
    if (role != RequestToolTipByExpressionRole)
        removeTooltip();
458 459

    switch (role) {
460 461 462 463 464 465 466 467
        case RequestActivateFrameRole:
            activateFrame(value.toInt());
            break;

        case RequestReloadFullStackRole:
            reloadFullStack();
            break;

468 469 470 471 472 473 474 475
        case RequestReloadSourceFilesRole:
            reloadSourceFiles();
            break;

        case RequestReloadModulesRole:
            reloadModules();
            break;

476 477 478 479
        case RequestReloadRegistersRole:
            reloadRegisters();
            break;

480 481 482 483
        case RequestExecDetachRole:
            detachDebugger();
            break;

484 485 486 487 488
        case RequestExecContinueRole:
            continueInferior();
            break;

        case RequestExecInterruptRole:
489
            requestInterruptInferior();
490 491 492
            break;

        case RequestExecResetRole:
493
            notifyEngineIll(); // FIXME: check
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
            break;

        case RequestExecStepRole:
            executeStepX();
            break;

        case RequestExecStepOutRole:
            executeStepOutX();
            break;

        case RequestExecNextRole:
            executeStepNextX();
            break;

        case RequestExecRunToLineRole:
hjk's avatar
hjk committed
509
            executeRunToLine();
510 511 512
            break;

        case RequestExecRunToFunctionRole:
hjk's avatar
hjk committed
513
            executeRunToFunction();
514 515 516 517 518 519 520
            break;

        case RequestExecReturnFromFunctionRole:
            executeReturnX();
            break;

        case RequestExecJumpToLineRole:
hjk's avatar
hjk committed
521
            executeJumpToLine();
522 523 524
            break;

        case RequestExecWatchRole:
hjk's avatar
hjk committed
525
            addToWatchWindow();
526 527 528
            break;

        case RequestExecExitRole:
529
            d->queueShutdownInferior();
530 531
            break;

532 533
        case RequestCreateSnapshotRole:
            createSnapshot();
534 535
            break;

536 537 538 539
        case RequestActivationRole:
            setActive(value.toBool());
            break;

540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
        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
555

556 557 558 559 560 561 562 563 564
        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;
        }

565 566 567
        case RequestToolTipByExpressionRole: {
            QList<QVariant> list = value.toList();
            QTC_ASSERT(list.size() == 3, break);
568 569 570
            QPoint point = list.at(0).value<QPoint>();
            TextEditor::ITextEditor *editor = // Eeks.
                (TextEditor::ITextEditor *)(list.at(1).value<quint64>());
hjk's avatar
hjk committed
571
            int pos = list.at(2).toInt();
572
            setToolTipExpression(point, editor, pos);
573 574 575
            break;
        }

576
        case RequestContextMenuRole: {
577
            QList<QVariant> list = value.toList();
578 579
            QTC_ASSERT(list.size() == 3, break);
            d->handleContextMenuRequest(list);
hjk's avatar
hjk committed
580
            break;
581
        }
582 583 584 585 586 587

        case RequestShowMemoryRole: {
            qDebug() << "CREATING MEMORY VIEW";
            (void) MemoryViewAgent(this, "0x0");
            break;
        }
588
    }
589
}
590 591 592 593 594 595 596 597 598 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

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

653 654 655 656
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
657 658 659 660 661 662 663 664

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

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
665 666 667 668
    QAbstractItemModel *model = d->m_modulesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ModulesModel"));
    return model;
669 670 671 672
}

QAbstractItemModel *DebuggerEngine::breakModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
673 674 675 676
    QAbstractItemModel *model = d->m_breakHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("BreakModel"));
    return model;
677 678 679 680
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
681 682 683 684
    QAbstractItemModel *model = d->m_registerHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
685 686 687 688
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
689 690 691 692
    QAbstractItemModel *model = d->m_stackHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("StackModel"));
    return model;
693 694 695 696
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
697 698 699 700
    QAbstractItemModel *model = d->m_threadsHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ThreadsModel"));
    return model;
701 702 703 704
}

QAbstractItemModel *DebuggerEngine::localsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
705 706 707 708
    QAbstractItemModel *model = d->m_watchHandler.model(LocalsWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
709 710 711 712
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
713 714 715 716
    QAbstractItemModel *model = d->m_watchHandler.model(WatchersWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("WatchersModel"));
    return model;
717 718 719 720
}

QAbstractItemModel *DebuggerEngine::returnModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
721 722 723 724
    QAbstractItemModel *model = d->m_watchHandler.model(ReturnWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ReturnModel"));
    return model;
725 726 727 728
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
729 730 731 732
    QAbstractItemModel *model = d->m_sourceFilesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
733 734 735 736
}

QAbstractItemModel *DebuggerEngine::commandModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
737 738 739 740
    QAbstractItemModel *model = d->m_commandHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("CommandModel"));
    return model;
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
}

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
{
758 759
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
760
    plugin()->showMessage(msg, channel, timeout);
761 762 763 764 765
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
766 767 768 769
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
770
    if (!isSessionEngine() && !d->m_runInWrapperEngine) {
771
        d->m_progress.setProgressRange(0, 1000);
772 773 774 775 776 777
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
        fp->setKeepOnFinish(false);
        d->m_progress.reportStarted();
    }
778 779
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
780 781

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
782 783
    QTC_ASSERT(sessionTemplate, notifyEngineSetupFailed(); return);
    QTC_ASSERT(sessionTemplate != this, notifyEngineSetupFailed(); return);
784 785

    breakHandler()->initializeFromTemplate(sessionTemplate->breakHandler());
786
    watchHandler()->initializeFromTemplate(sessionTemplate->watchHandler());
787 788 789 790 791 792 793

    d->m_runControl = runControl;

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

    if (d->m_startParameters.environment.empty())
794
        d->m_startParameters.environment = Utils::Environment().toStringList();
795 796 797 798 799 800 801 802

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

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

803 804
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
hjk's avatar
hjk committed
805
    setState(EngineSetupRequested);
806

807
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
808
    setupEngine();
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
}

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
883
static TextEditor::ITextEditor *currentTextEditor()
884
{
hjk's avatar
hjk committed
885 886 887 888 889
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return 0;
    Core::IEditor *editor = editorManager->currentEditor();
    return qobject_cast<ITextEditor*>(editor);
890 891
}

hjk's avatar
hjk committed
892
void DebuggerEngine::executeRunToLine()
893
{
hjk's avatar
hjk committed
894
    ITextEditor *textEditor = currentTextEditor();
895 896
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
hjk's avatar
hjk committed
897 898
    if (fileName.isEmpty())
        return;
899
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
900 901
    resetLocation();
    executeRunToLine(fileName, lineNumber);
902 903
}

hjk's avatar
hjk committed
904
void DebuggerEngine::executeRunToFunction()
905
{
hjk's avatar
hjk committed
906
    ITextEditor *textEditor = currentTextEditor();
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
    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
931 932 933 934
    if (functionName.isEmpty())
        return;
    resetLocation();
    executeRunToFunction(functionName);
935 936
}

hjk's avatar
hjk committed
937
void DebuggerEngine::executeJumpToLine()
938
{
hjk's avatar
hjk committed
939
    ITextEditor *textEditor = currentTextEditor();
940 941 942
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
943 944 945
    if (fileName.isEmpty())
        return;
    executeJumpToLine(fileName, lineNumber);
946 947
}

hjk's avatar
hjk committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
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);
    }
971 972 973
    if (exp.isEmpty())
        return;
    watchHandler()->watchExpression(exp);
hjk's avatar
hjk committed
974 975
}

976 977 978
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
979
    showMessage("HANDLE RUNCONTROL START FAILED");
980
    d->m_runControl = 0;
981

982
    d->m_progress.setProgressValue(900);
983 984
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
985 986
}

987 988
// Called from RunControl.
void DebuggerEngine::handleFinished()
989
{
990
    showMessage("HANDLE RUNCONTROL FINISHED");
991
    d->m_runControl = 0;
992 993 994 995
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
996 997

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
998 999
    QTC_ASSERT(sessionTemplate != this, /**/);
    breakHandler()->storeToTemplate(sessionTemplate->breakHandler());
1000
    watchHandler()->storeToTemplate(sessionTemplate->watchHandler());
1001

1002
    d->m_progress.setProgressValue(1000);
1003
    d->m_progress.reportFinished();
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
}

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)
{
1045
    QMessageBox dialog(plugin()->mainWindow());
Leena Miettinen's avatar
Leena Miettinen committed
1046
    QPushButton *qtPref = dialog.addButton(tr("Open Qt4 Options"),
1047
        QMessageBox::ActionRole);
Leena Miettinen's avatar
Leena Miettinen committed
1048
    QPushButton *helperOff = dialog.addButton(tr("Turn off Helper Usage"),
1049
        QMessageBox::ActionRole);
Leena Miettinen's avatar
Leena Miettinen committed
1050
    QPushButton *justContinue = dialog.addButton(tr("Continue Anyway"),
1051 1052
        QMessageBox::AcceptRole);
    dialog.setDefaultButton(justContinue);
Leena Miettinen's avatar
Leena Miettinen committed
1053
    dialog.setWindowTitle(tr("Debugging Helper Missing"));
1054 1055 1056 1057 1058
    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. "
Leena Miettinen's avatar
Leena Miettinen committed
1059 1060
        "On the Qt4 options page, select a Qt installation "
        "and click Rebuild."));
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
    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
1086
DebuggerState DebuggerEngine::lastGoodState() const
1087
{
hjk's avatar
hjk committed
1088 1089 1090 1091 1092 1093 1094
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
1096 1097 1098
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
1099
    case DebuggerNotReady:
1100
        return to == EngineSetupRequested;
1101

hjk's avatar
hjk committed
1102
    case EngineSetupRequested:
1103 1104
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
1105
        // FIXME: In therory it's the engine's task to go into a
1106 1107 1108
        // proper "Shutdown" state before calling notifyEngineSetupFailed
        //return to == DebuggerFinished;
        return to == EngineShutdownRequested;
1109
    case EngineSetupOk:
hjk's avatar
hjk committed
1110
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
1111

hjk's avatar
hjk committed
1112 1113
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
1114
    case InferiorSetupFailed:
hjk's avatar
hjk committed
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
        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 ==