debuggerengine.cpp 45.7 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),
114 115 116
    toolChainType(ToolChain::UNKNOWN),
    startMode(NoStartMode),
    executableUid(0)
117 118 119 120 121 122 123 124 125 126 127 128
{}

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


namespace Debugger {

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

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


namespace Internal {

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

186

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

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

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

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


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

218
class DebuggerEnginePrivate : public QObject
219
{
220 221
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
243

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

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

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

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


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

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

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
296 297

    // The current state.
298 299
    DebuggerState m_state;

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

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

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

    bool m_runInWrapperEngine;
320 321
};

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
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
348
    TextEditor::ITextEditor *editor =
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
        (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);
    }
}
401 402 403 404 405 406 407 408 409 410 411 412 413 414

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

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

DebuggerEngine::~DebuggerEngine()
{
415 416
    disconnect();
    delete d;
417 418
}

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

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

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

        case RequestReloadModulesRole:
            reloadModules();
            break;

437 438 439 440
        case RequestReloadRegistersRole:
            reloadRegisters();
            break;

441 442 443 444
        case RequestExecDetachRole:
            detachDebugger();
            break;

445 446 447 448 449
        case RequestExecContinueRole:
            continueInferior();
            break;

        case RequestExecInterruptRole:
450
            requestInterruptInferior();
451 452 453
            break;

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

        case RequestExecStepRole:
            executeStepX();
            break;

        case RequestExecStepOutRole:
            executeStepOutX();
            break;

        case RequestExecNextRole:
            executeStepNextX();
            break;

        case RequestExecRunToLineRole:
hjk's avatar
hjk committed
470
            executeRunToLine();
471 472 473
            break;

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

        case RequestExecReturnFromFunctionRole:
            executeReturnX();
            break;

        case RequestExecJumpToLineRole:
hjk's avatar
hjk committed
482
            executeJumpToLine();
483 484 485
            break;

        case RequestExecWatchRole:
hjk's avatar
hjk committed
486
            addToWatchWindow();
487 488 489
            break;

        case RequestExecExitRole:
490
            d->queueShutdownInferior();
491 492
            break;

493 494
        case RequestCreateSnapshotRole:
            createSnapshot();
495 496
            break;

497 498 499 500
        case RequestActivationRole:
            setActive(value.toBool());
            break;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

957
    d->m_progress.setProgressValue(1000);
958
    d->m_progress.reportFinished();
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 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
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

hjk's avatar
hjk committed
1171 1172
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
1173
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
1174 1175
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
1176