debuggerengine.cpp 45.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#include "debuggerengine.h"

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

#include "breakhandler.h"
#include "moduleshandler.h"
#include "registerhandler.h"
#include "snapshothandler.h"
#include "sourcefileshandler.h"
#include "stackhandler.h"
#include "threadshandler.h"
#include "watchhandler.h"
hjk's avatar
hjk committed
47
#include "watchutils.h"
48

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

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

#include <qt4projectmanager/qt4projectmanagerconstants.h>

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

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

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

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


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

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

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

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

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


namespace Debugger {

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

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

188

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

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

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

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


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

220
class DebuggerEnginePrivate : public QObject
221
{
222 223
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
245

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

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

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

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


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

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

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
298 299

    // The current state.
300 301
    DebuggerState m_state;

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

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

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

    bool m_runInWrapperEngine;
322 323
};

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
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
350
    TextEditor::ITextEditor *editor =
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
        (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);
    }
}
403 404 405 406 407 408 409 410 411 412 413 414 415 416

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

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

DebuggerEngine::~DebuggerEngine()
{
417 418
    disconnect();
    delete d;
419 420
}

421
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
422
{
423
    showMessage(msg, StatusBar, timeout);
424
}
425 426 427 428 429 430 431 432 433 434 435 436 437 438

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

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

        case RequestReloadModulesRole:
            reloadModules();
            break;

439 440 441 442
        case RequestReloadRegistersRole:
            reloadRegisters();
            break;

443 444 445 446
        case RequestExecDetachRole:
            detachDebugger();
            break;

447 448 449 450 451
        case RequestExecContinueRole:
            continueInferior();
            break;

        case RequestExecInterruptRole:
452
            requestInterruptInferior();
453 454 455
            break;

        case RequestExecResetRole:
456
            notifyEngineIll(); // FIXME: check
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
            break;

        case RequestExecStepRole:
            executeStepX();
            break;

        case RequestExecStepOutRole:
            executeStepOutX();
            break;

        case RequestExecNextRole:
            executeStepNextX();
            break;

        case RequestExecRunToLineRole:
hjk's avatar
hjk committed
472
            executeRunToLine();
473 474 475
            break;

        case RequestExecRunToFunctionRole:
hjk's avatar
hjk committed
476
            executeRunToFunction();
477 478 479 480 481 482 483
            break;

        case RequestExecReturnFromFunctionRole:
            executeReturnX();
            break;

        case RequestExecJumpToLineRole:
hjk's avatar
hjk committed
484
            executeJumpToLine();
485 486 487
            break;

        case RequestExecWatchRole:
hjk's avatar
hjk committed
488
            addToWatchWindow();
489 490 491
            break;

        case RequestExecExitRole:
492
            d->queueShutdownInferior();
493 494
            break;

495 496
        case RequestCreateSnapshotRole:
            createSnapshot();
497 498
            break;

499 500 501 502
        case RequestActivationRole:
            setActive(value.toBool());
            break;

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
        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
518

519 520 521 522 523 524 525 526 527
        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;
        }

528 529 530
        case RequestToolTipByExpressionRole: {
            QList<QVariant> list = value.toList();
            QTC_ASSERT(list.size() == 3, break);
531 532 533
            QPoint point = list.at(0).value<QPoint>();
            TextEditor::ITextEditor *editor = // Eeks.
                (TextEditor::ITextEditor *)(list.at(1).value<quint64>());
hjk's avatar
hjk committed
534
            int pos = list.at(2).toInt();
535
            setToolTipExpression(point, editor, pos);
536 537 538
            break;
        }

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

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

610 611 612 613
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
614 615 616 617 618 619 620 621

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

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
622 623 624 625
    QAbstractItemModel *model = d->m_modulesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ModulesModel"));
    return model;
626 627 628 629
}

QAbstractItemModel *DebuggerEngine::breakModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
630 631 632 633
    QAbstractItemModel *model = d->m_breakHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("BreakModel"));
    return model;
634 635 636 637
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
638 639 640 641
    QAbstractItemModel *model = d->m_registerHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
642 643 644 645
}

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

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

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

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

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

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

QAbstractItemModel *DebuggerEngine::commandModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
694 695 696 697
    QAbstractItemModel *model = d->m_commandHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("CommandModel"));
    return model;
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
}

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
{
715 716
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
717
    plugin()->showMessage(msg, channel, timeout);
718 719 720 721 722
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
723 724 725 726
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
hjk's avatar
hjk committed
727
    if (!isSessionEngine()) {
728
        d->m_progress.setProgressRange(0, 1000);
729 730 731 732 733 734
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
        fp->setKeepOnFinish(false);
        d->m_progress.reportStarted();
    }
735 736
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
737 738

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
739 740
    QTC_ASSERT(sessionTemplate, notifyEngineSetupFailed(); return);
    QTC_ASSERT(sessionTemplate != this, notifyEngineSetupFailed(); return);
741 742

    breakHandler()->initializeFromTemplate(sessionTemplate->breakHandler());
743
    watchHandler()->initializeFromTemplate(sessionTemplate->watchHandler());
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759

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

760 761
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
hjk's avatar
hjk committed
762
    setState(EngineSetupRequested);
763

764
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
765
    setupEngine();
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 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
}

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
840
static TextEditor::ITextEditor *currentTextEditor()
841
{
hjk's avatar
hjk committed
842 843 844 845 846
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return 0;
    Core::IEditor *editor = editorManager->currentEditor();
    return qobject_cast<ITextEditor*>(editor);
847 848
}

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

hjk's avatar
hjk committed
861
void DebuggerEngine::executeRunToFunction()
862
{
hjk's avatar
hjk committed
863
    ITextEditor *textEditor = currentTextEditor();
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    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
888 889 890 891
    if (functionName.isEmpty())
        return;
    resetLocation();
    executeRunToFunction(functionName);
892 893
}

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

hjk's avatar
hjk committed
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
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);
    }
928 929 930
    if (exp.isEmpty())
        return;
    watchHandler()->watchExpression(exp);
hjk's avatar
hjk committed
931 932
}

933 934 935
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
936
    showMessage("HANDLE RUNCONTROL START FAILED");
937
    d->m_runControl = 0;
938

939
    d->m_progress.setProgressValue(900);
940 941
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
942 943
}

944 945
// Called from RunControl.
void DebuggerEngine::handleFinished()
946
{
947
    showMessage("HANDLE RUNCONTROL FINISHED");
948
    d->m_runControl = 0;
949 950 951 952
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
953 954

    DebuggerEngine *sessionTemplate = plugin()->sessionTemplate();
955 956
    QTC_ASSERT(sessionTemplate != this, /**/);
    breakHandler()->storeToTemplate(sessionTemplate->breakHandler());
957
    watchHandler()->storeToTemplate(sessionTemplate->watchHandler());
958

959
    d->m_progress.setProgressValue(1000);
960
    d->m_progress.reportFinished();
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 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 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
}

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
1044
DebuggerState DebuggerEngine::lastGoodState() const
1045
{
hjk's avatar
hjk committed
1046 1047 1048 1049 1050 1051 1052
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
1054 1055 1056
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
1057
    case DebuggerNotReady:
1058
        return to == EngineSetupRequested;
1059

hjk's avatar
hjk committed
1060
    case EngineSetupRequested:
1061 1062
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
1063
        // FIXME: In therory it's the engine's task to go into a
1064 1065 1066
        // proper "Shutdown" state before calling notifyEngineSetupFailed
        //return to == DebuggerFinished;
        return to == EngineShutdownRequested;
1067
    case EngineSetupOk:
hjk's avatar
hjk committed
1068
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
1069

hjk's avatar
hjk committed
1070 1071
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
1072
    case InferiorSetupFailed:
hjk's avatar
hjk committed
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
        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;
1094
    case InferiorStopFailed:
hjk's avatar
hjk committed
1095
        return to == EngineShutdownRequested;
1096 1097

    case InferiorUnrunnable:
hjk's avatar
hjk committed
1098 1099 1100 1101 1102
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
1103
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
1104
        return to == EngineShutdownRequested;
1105

hjk's avatar
hjk committed
1106 1107 1108 1109 1110 1111 1112 1113
    case EngineShutdownRequested:
        return to == EngineShutdownOk;
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
1114
        return to == EngineSetupRequested; // Happens on restart.
1115 1116 1117 1118 1119 1120
    }

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

1121
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
1122
{
hjk's avatar
hjk committed
1123
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
1124
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
1125
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
1126 1127
    QTC_ASSERT(d->m_runControl, return);
    d->m_runControl->startFailed();
hjk's avatar
hjk committed
1128
    d->queueShutdownEngine();
hjk's avatar
hjk committed
1129 1130
}

1131
void DebuggerEngine::notifyEngineSetupOk()
1132
{
hjk's avatar
hjk committed
1133
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
1134
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
1135
    setState(EngineSetupOk);
hjk's avatar
hjk committed
1136
    QTC_ASSERT(d->m_runControl, return);
hjk's avatar
hjk committed
1137
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
1138
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
1139 1140
}

hjk's avatar
hjk committed
1141
void DebuggerEnginePrivate::doSetupInferior()
1142
{
1143
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
1144
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
1145
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
1146
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
1147 1148 1149 1150 1151
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
1152
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
1153
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
1154
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
1155
    d->queueShutdownEngine();
hjk's avatar
hjk committed
1156 1157 1158 1159
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
1160
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
1161
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
1162
    d->queueRunEngine();
hjk's avatar
hjk committed
1163 1164 1165 1166
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
1167
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
1168
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
1169
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
1170 1171 1172
    m_engine->runEngine();
}

hjk's avatar
hjk committed
1173 1174
void DebuggerEngine::notifyInferiorUnrunnable()
{