debuggerengine.cpp 48.6 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

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

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

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

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

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


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

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

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

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

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


namespace Debugger {

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

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

187

188 189 190 191 192 193 194 195 196
//////////////////////////////////////////////////////////////////////
//
// CommandHandler
//
//////////////////////////////////////////////////////////////////////

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

private:
202
    QPointer<DebuggerEngine> m_engine;
203 204
};

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


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

219
class DebuggerEnginePrivate : public QObject
220
{
221 222
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
244

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

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

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

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


289
public:
hjk's avatar
hjk committed
290 291
    DebuggerState state() const { return m_state; }

292 293
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.
294
    bool m_isActive;
295 296

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
297 298

    // The current state.
299 300
    DebuggerState m_state;

hjk's avatar
hjk committed
301 302 303 304 305 306
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

307 308 309 310 311 312 313 314 315 316 317
    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;
318
    QFutureInterface<void> m_progress;
319 320

    bool m_runInWrapperEngine;
321 322
};

323 324 325 326 327
void DebuggerEnginePrivate::breakpointSetRemoveMarginActionTriggered()
{
    QAction *act = qobject_cast<QAction *>(sender());
    QTC_ASSERT(act, return);
    QList<QVariant> list = act->data().toList();
328
    QTC_ASSERT(list.size() >= 3, return);
329 330
    const QString fileName = list.at(0).toString();
    const int lineNumber = list.at(1).toInt();
331 332
    const quint64 address = list.at(2).toULongLong();
    m_breakHandler.toggleBreakpoint(fileName, lineNumber, address);
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
}

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
350
    TextEditor::ITextEditor *editor =
351 352 353 354 355 356
        (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;
357
    quint64 address = 0;
358 359 360 361 362
    if (editor->property("DisassemblerView").toBool()) {
        fileName = editor->file()->fileName();
        QString line = editor->contents()
            .section('\n', lineNumber - 1, lineNumber - 1);
        BreakpointData needle;
363 364
        address = needle.address = DisassemblerViewAgent::addressFromDisassemblyLine(line);
        needle.bpLineNumber = -1;
365 366 367 368 369 370 371 372 373
        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);
374
    args.append(address);
375 376 377

    if (data) {
        // existing breakpoint
378 379
        const QString number = QString::fromAscii(data->bpNumber);
        QAction *act = new QAction(tr("Remove Breakpoint %1").arg(number), menu);
380 381 382 383 384 385 386
        act->setData(args);
        connect(act, SIGNAL(triggered()),
            this, SLOT(breakpointSetRemoveMarginActionTriggered()));
        menu->addAction(act);

        QAction *act2;
        if (data->enabled)
387
            act2 = new QAction(tr("Disable Breakpoint %1").arg(number), menu);
388
        else
389
            act2 = new QAction(tr("Enable Breakpoint %1").arg(number), menu);
390 391 392 393 394 395
        act2->setData(args);
        connect(act2, SIGNAL(triggered()),
            this, SLOT(breakpointEnableDisableMarginActionTriggered()));
        menu->addAction(act2);
    } else {
        // non-existing
396 397 398 399
        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);
400 401 402 403 404 405
        act->setData(args);
        connect(act, SIGNAL(triggered()),
            this, SLOT(breakpointSetRemoveMarginActionTriggered()));
        menu->addAction(act);
    }
}
406 407 408 409 410 411 412 413 414 415 416 417 418 419

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

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

DebuggerEngine::~DebuggerEngine()
{
420 421
    disconnect();
    delete d;
422 423
}

424
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
425
{
426
    showMessage(msg, StatusBar, timeout);
427
}
428

429 430 431 432 433 434
void DebuggerEngine::removeTooltip()
{
    watchHandler()->removeTooltip();
    hideDebuggerToolTip();
}

435 436
void DebuggerEngine::handleCommand(int role, const QVariant &value)
{
437 438
    if (role != RequestToolTipByExpressionRole)
        removeTooltip();
439 440

    switch (role) {
441 442 443 444 445 446 447 448
        case RequestActivateFrameRole:
            activateFrame(value.toInt());
            break;

        case RequestReloadFullStackRole:
            reloadFullStack();
            break;

449 450 451 452 453 454 455 456
        case RequestReloadSourceFilesRole:
            reloadSourceFiles();
            break;

        case RequestReloadModulesRole:
            reloadModules();
            break;

457 458 459 460
        case RequestReloadRegistersRole:
            reloadRegisters();
            break;

461 462 463 464
        case RequestExecDetachRole:
            detachDebugger();
            break;

465 466 467 468 469
        case RequestExecContinueRole:
            continueInferior();
            break;

        case RequestExecInterruptRole:
470
            requestInterruptInferior();
471 472 473
            break;

        case RequestExecResetRole:
474
            notifyEngineIll(); // FIXME: check
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
            break;

        case RequestExecStepRole:
            executeStepX();
            break;

        case RequestExecStepOutRole:
            executeStepOutX();
            break;

        case RequestExecNextRole:
            executeStepNextX();
            break;

        case RequestExecRunToLineRole:
hjk's avatar
hjk committed
490
            executeRunToLine();
491 492 493
            break;

        case RequestExecRunToFunctionRole:
hjk's avatar
hjk committed
494
            executeRunToFunction();
495 496 497 498 499 500 501
            break;

        case RequestExecReturnFromFunctionRole:
            executeReturnX();
            break;

        case RequestExecJumpToLineRole:
hjk's avatar
hjk committed
502
            executeJumpToLine();
503 504 505
            break;

        case RequestExecWatchRole:
hjk's avatar
hjk committed
506
            addToWatchWindow();
507 508 509
            break;

        case RequestExecExitRole:
510
            d->queueShutdownInferior();
511 512
            break;

513 514
        case RequestCreateSnapshotRole:
            createSnapshot();
515 516
            break;

517 518 519 520
        case RequestActivationRole:
            setActive(value.toBool());
            break;

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
        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
536

537 538 539 540 541 542 543 544 545
        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;
        }

546 547 548
        case RequestToolTipByExpressionRole: {
            QList<QVariant> list = value.toList();
            QTC_ASSERT(list.size() == 3, break);
549 550 551
            QPoint point = list.at(0).value<QPoint>();
            TextEditor::ITextEditor *editor = // Eeks.
                (TextEditor::ITextEditor *)(list.at(1).value<quint64>());
hjk's avatar
hjk committed
552
            int pos = list.at(2).toInt();
553
            setToolTipExpression(point, editor, pos);
554 555 556
            break;
        }

557
        case RequestContextMenuRole: {
558
            QList<QVariant> list = value.toList();
559 560
            QTC_ASSERT(list.size() == 3, break);
            d->handleContextMenuRequest(list);
hjk's avatar
hjk committed
561
            break;
562
        }
563 564 565 566 567 568

        case RequestShowMemoryRole: {
            qDebug() << "CREATING MEMORY VIEW";
            (void) MemoryViewAgent(this, "0x0");
            break;
        }
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 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

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

634 635 636 637
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
638 639 640 641 642 643 644 645

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

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
646 647 648 649
    QAbstractItemModel *model = d->m_modulesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ModulesModel"));
    return model;
650 651 652 653
}

QAbstractItemModel *DebuggerEngine::breakModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
654 655 656 657
    QAbstractItemModel *model = d->m_breakHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("BreakModel"));
    return model;
658 659 660 661
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
662 663 664 665
    QAbstractItemModel *model = d->m_registerHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
666 667 668 669
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
670 671 672 673
    QAbstractItemModel *model = d->m_stackHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("StackModel"));
    return model;
674 675 676 677
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
678 679 680 681
    QAbstractItemModel *model = d->m_threadsHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ThreadsModel"));
    return model;
682 683 684 685
}

QAbstractItemModel *DebuggerEngine::localsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
686 687 688 689
    QAbstractItemModel *model = d->m_watchHandler.model(LocalsWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
690 691 692 693
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
694 695 696 697
    QAbstractItemModel *model = d->m_watchHandler.model(WatchersWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("WatchersModel"));
    return model;
698 699 700 701
}

QAbstractItemModel *DebuggerEngine::returnModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
702 703 704 705
    QAbstractItemModel *model = d->m_watchHandler.model(ReturnWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ReturnModel"));
    return model;
706 707 708 709
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
710 711 712 713
    QAbstractItemModel *model = d->m_sourceFilesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
714 715 716 717
}

QAbstractItemModel *DebuggerEngine::commandModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
718 719 720 721
    QAbstractItemModel *model = d->m_commandHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("CommandModel"));
    return model;
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
}

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
{
739 740
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
741
    plugin()->showMessage(msg, channel, timeout);
742 743 744 745 746
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
747 748 749 750
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
751
    if (!isSessionEngine() && !d->m_runInWrapperEngine) {
752
        d->m_progress.setProgressRange(0, 1000);
753 754 755 756 757 758
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
        fp->setKeepOnFinish(false);
        d->m_progress.reportStarted();
    }
759 760
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
761 762

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
763 764
    QTC_ASSERT(sessionTemplate, notifyEngineSetupFailed(); return);
    QTC_ASSERT(sessionTemplate != this, notifyEngineSetupFailed(); return);
765 766

    breakHandler()->initializeFromTemplate(sessionTemplate->breakHandler());
767
    watchHandler()->initializeFromTemplate(sessionTemplate->watchHandler());
768 769 770 771 772 773 774

    d->m_runControl = runControl;

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

    if (d->m_startParameters.environment.empty())
775
        d->m_startParameters.environment = Utils::Environment().toStringList();
776 777 778 779 780 781 782 783

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

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

784 785
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
hjk's avatar
hjk committed
786
    setState(EngineSetupRequested);
787

788
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
789
    setupEngine();
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 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
}

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
864
static TextEditor::ITextEditor *currentTextEditor()
865
{
hjk's avatar
hjk committed
866 867 868 869 870
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return 0;
    Core::IEditor *editor = editorManager->currentEditor();
    return qobject_cast<ITextEditor*>(editor);
871 872
}

hjk's avatar
hjk committed
873
void DebuggerEngine::executeRunToLine()
874
{
hjk's avatar
hjk committed
875
    ITextEditor *textEditor = currentTextEditor();
876 877
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
hjk's avatar
hjk committed
878 879
    if (fileName.isEmpty())
        return;
880
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
881 882
    resetLocation();
    executeRunToLine(fileName, lineNumber);
883 884
}

hjk's avatar
hjk committed
885
void DebuggerEngine::executeRunToFunction()
886
{
hjk's avatar
hjk committed
887
    ITextEditor *textEditor = currentTextEditor();
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
    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
912 913 914 915
    if (functionName.isEmpty())
        return;
    resetLocation();
    executeRunToFunction(functionName);
916 917
}

hjk's avatar
hjk committed
918
void DebuggerEngine::executeJumpToLine()
919
{
hjk's avatar
hjk committed
920
    ITextEditor *textEditor = currentTextEditor();
921 922 923
    QTC_ASSERT(textEditor, return);
    QString fileName = textEditor->file()->fileName();
    int lineNumber = textEditor->currentLine();
hjk's avatar
hjk committed
924 925 926
    if (fileName.isEmpty())
        return;
    executeJumpToLine(fileName, lineNumber);
927 928
}

hjk's avatar
hjk committed
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
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);
    }
952 953 954
    if (exp.isEmpty())
        return;
    watchHandler()->watchExpression(exp);
hjk's avatar
hjk committed
955 956
}

957 958 959
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
960
    showMessage("HANDLE RUNCONTROL START FAILED");
961
    d->m_runControl = 0;
962

963
    d->m_progress.setProgressValue(900);
964 965
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
966 967
}

968 969
// Called from RunControl.
void DebuggerEngine::handleFinished()
970
{
971
    showMessage("HANDLE RUNCONTROL FINISHED");
972
    d->m_runControl = 0;
973 974 975 976
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
977 978

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
979 980
    QTC_ASSERT(sessionTemplate != this, /**/);
    breakHandler()->storeToTemplate(sessionTemplate->breakHandler());
981
    watchHandler()->storeToTemplate(sessionTemplate->watchHandler());
982

983
    d->m_progress.setProgressValue(1000);
984
    d->m_progress.reportFinished();
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
}

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;
Leena Miettinen's avatar
Leena Miettinen committed
1028
    QPushButton *qtPref = dialog.addButton(tr("Open Qt4 Options"),
1029
        QMessageBox::ActionRole);
Leena Miettinen's avatar
Leena Miettinen committed
1030
    QPushButton *helperOff = dialog.addButton(tr("Turn off Helper Usage"),
1031
        QMessageBox::ActionRole);
Leena Miettinen's avatar
Leena Miettinen committed
1032
    QPushButton *justContinue = dialog.addButton(tr("Continue Anyway"),
1033 1034
        QMessageBox::AcceptRole);
    dialog.setDefaultButton(justContinue);
Leena Miettinen's avatar
Leena Miettinen committed
1035
    dialog.setWindowTitle(tr("Debugging Helper Missing"));
1036 1037 1038 1039 1040
    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
1041 1042
        "On the Qt4 options page, select a Qt installation "
        "and click Rebuild."));
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
    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
1068
DebuggerState DebuggerEngine::lastGoodState() const
1069
{
hjk's avatar
hjk committed
1070 1071 1072 1073 1074 1075 1076
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
1078 1079 1080
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
1081
    case DebuggerNotReady:
1082
        return to == EngineSetupRequested;
1083

hjk's avatar
hjk committed
1084
    case EngineSetupRequested:
1085 1086
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
1087
        // FIXME: In therory it's the engine's task to go into a
1088 1089 1090
        // proper "Shutdown" state before calling notifyEngineSetupFailed
        //return to == DebuggerFinished;
        return to == EngineShutdownRequested;
1091
    case EngineSetupOk:
hjk's avatar
hjk committed
1092
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
1093

hjk's avatar
hjk committed
1094 1095
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
1096
    case InferiorSetupFailed:
hjk's avatar
hjk committed
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
        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;
1118
    case InferiorStopFailed:
hjk's avatar
hjk committed
1119
        return to == EngineShutdownRequested;
1120 1121

    case InferiorUnrunnable:
hjk's avatar
hjk committed
1122 1123 1124 1125 1126
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
1127
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
1128
        return to == EngineShutdownRequested;
1129

hjk's avatar
hjk committed
1130
    case EngineShutdownRequested:
1131
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
1132 1133 1134 1135 1136 1137
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
1138
        return to == EngineSetupRequested; // Happens on restart.
1139 1140 1141 1142 1143 1144
    }

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