qmlengine.cpp 18.4 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
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 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 "qmlengine.h"
Lasse Holmstedt's avatar
Lasse Holmstedt committed
31
#include "qmladapter.h"
32

33
#include "debuggerconstants.h"
34
#include "debuggerplugin.h"
35
#include "debuggerdialogs.h"
36
#include "debuggerstringutils.h"
37
#include "debuggeruiswitcher.h"
38
#include "debuggerrunner.h"
39

40 41 42 43 44 45 46
#include "breakhandler.h"
#include "moduleshandler.h"
#include "registerhandler.h"
#include "stackhandler.h"
#include "watchhandler.h"
#include "watchutils.h"

Lasse Holmstedt's avatar
Lasse Holmstedt committed
47
#include <extensionsystem/pluginmanager.h>
48 49
#include <projectexplorer/environment.h>

50 51 52 53 54 55 56 57 58 59 60 61 62
#include <utils/qtcassert.h>

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

#include <QtGui/QAction>
#include <QtGui/QApplication>
#include <QtGui/QMainWindow>
#include <QtGui/QMessageBox>
#include <QtGui/QToolTip>
63
#include <QtGui/QTextDocument>
64 65

#include <QtNetwork/QTcpSocket>
66 67
#include <QtNetwork/QHostAddress>

68 69 70 71 72 73 74 75
#define DEBUG_QML 1
#if DEBUG_QML
#   define SDEBUG(s) qDebug() << s
#else
#   define SDEBUG(s)
#endif
# define XSDEBUG(s) qDebug() << s

Lasse Holmstedt's avatar
Lasse Holmstedt committed
76 77
enum {
    MaxConnectionAttempts = 50,
78
    ConnectionAttemptDefaultInterval = 200
Lasse Holmstedt's avatar
Lasse Holmstedt committed
79
};
80

81 82 83
namespace Debugger {
namespace Internal {

84 85 86 87 88 89
QDataStream& operator>>(QDataStream& s, WatchData &data)
{
    data = WatchData();
    QString value;
    QString type;
    bool hasChildren;
90
    s >> data.exp >> data.name >> value >> type >> hasChildren >> data.objectId;
91 92 93
    data.setType(type, false);
    data.setValue(value);
    data.setHasChildren(hasChildren);
94
    data.setAllUnneeded();
95 96 97
    return s;
}

98 99 100 101 102 103
///////////////////////////////////////////////////////////////////////
//
// QmlEngine
//
///////////////////////////////////////////////////////////////////////

104
QmlEngine::QmlEngine(const DebuggerStartParameters &startParameters)
Lasse Holmstedt's avatar
Lasse Holmstedt committed
105 106 107 108
    : DebuggerEngine(startParameters)
    , m_ping(0)
    , m_adapter(new QmlAdapter(this))
    , m_addedAdapterToObjectPool(false)
109 110
    , m_attachToRunningExternalApp(false)
    , m_hasShutdown(false)
111
{
Friedemann Kleint's avatar
Friedemann Kleint committed
112
    setObjectName(QLatin1String("QmlEngine"));
113 114 115 116 117 118
}

QmlEngine::~QmlEngine()
{
}

119 120 121 122 123 124 125 126 127 128
void QmlEngine::setAttachToRunningExternalApp(bool value)
{
    m_attachToRunningExternalApp = value;
}

void QmlEngine::pauseConnection()
{
    m_adapter->pauseConnection();
}

hjk's avatar
hjk committed
129
void QmlEngine::setupInferior()
130
{
hjk's avatar
hjk committed
131
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
Lasse Holmstedt's avatar
Lasse Holmstedt committed
132

133 134 135 136 137 138 139 140 141
    connect(&m_applicationLauncher, SIGNAL(processExited(int)),
            this, SLOT(disconnected()));
    connect(&m_applicationLauncher, SIGNAL(appendMessage(QString,bool)),
            this, SLOT(slotMessage(QString, bool)));
    connect(&m_applicationLauncher, SIGNAL(appendOutput(QString, bool)),
            this, SLOT(slotAddToOutputWindow(QString, bool)));
    connect(&m_applicationLauncher, SIGNAL(bringToForegroundRequested(qint64)),
            runControl(), SLOT(bringApplicationToForeground(qint64)));

Lasse Holmstedt's avatar
Lasse Holmstedt committed
142 143 144
    m_applicationLauncher.setEnvironment(startParameters().environment);
    m_applicationLauncher.setWorkingDirectory(startParameters().workingDirectory);

hjk's avatar
hjk committed
145 146
    notifyInferiorSetupOk();
}
hjk's avatar
hjk committed
147

Lasse Holmstedt's avatar
Lasse Holmstedt committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
void QmlEngine::connectionEstablished()
{
    attemptBreakpointSynchronization();

    ExtensionSystem::PluginManager *pluginManager = ExtensionSystem::PluginManager::instance();
    pluginManager->addObject(m_adapter);
    m_addedAdapterToObjectPool = true;

    plugin()->showMessage(tr("QML Debugger connected."), StatusBar);

    notifyEngineRunAndInferiorRunOk();
}

void QmlEngine::connectionStartupFailed()
{
    QMessageBox::critical(0,
                          tr("Failed to connect to debugger"),
                          tr("Could not connect to debugger server.") );
    notifyEngineRunFailed();
}

void QmlEngine::connectionError()
{
    // do nothing for now - only exit the debugger when inferior exits.
}

hjk's avatar
hjk committed
174 175 176
void QmlEngine::runEngine()
{
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
Lasse Holmstedt's avatar
Lasse Holmstedt committed
177

178 179 180 181 182
    if (!m_attachToRunningExternalApp) {
        m_applicationLauncher.start(ProjectExplorer::ApplicationLauncher::Gui,
                                    startParameters().executable,
                                    startParameters().processArgs);
    }
Lasse Holmstedt's avatar
Lasse Holmstedt committed
183 184 185

    m_adapter->beginConnection();
    plugin()->showMessage(tr("QML Debugger connecting..."), StatusBar);
186 187 188 189 190
}

void QmlEngine::shutdownInferiorAsSlave()
{
    resetLocation();
191

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
    // This can be issued in almost any state. We assume, though,
    // that at this point of time the inferior is not running anymore,
    // even if stop notification were not issued or got lost.
    if (state() == InferiorRunOk) {
        setState(InferiorStopRequested);
        setState(InferiorStopOk);
    }
    setState(InferiorShutdownRequested);
    setState(InferiorShutdownOk);
}

void QmlEngine::shutdownEngineAsSlave()
{
    if (m_hasShutdown)
        return;

    disconnect(m_adapter, SIGNAL(connectionStartupFailed()), this, SLOT(connectionStartupFailed()));
    m_adapter->closeConnection();

    if (m_addedAdapterToObjectPool) {
        ExtensionSystem::PluginManager *pluginManager = ExtensionSystem::PluginManager::instance();
        pluginManager->removeObject(m_adapter);
    }

    if (m_attachToRunningExternalApp) {
        setState(EngineShutdownRequested, true);
        setState(EngineShutdownOk, true);
        setState(DebuggerFinished, true);
    } else {
        if (m_applicationLauncher.isRunning()) {
            // should only happen if engine is ill
            disconnect(&m_applicationLauncher, SIGNAL(processExited(int)), this, SLOT(disconnected()));
            m_applicationLauncher.stop();
        }
    }
    m_hasShutdown = true;
228 229
}

hjk's avatar
hjk committed
230
void QmlEngine::shutdownInferior()
231
{
232 233 234 235
    // don't do normal shutdown if running as slave engine
    if (m_attachToRunningExternalApp)
        return;

hjk's avatar
hjk committed
236
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
Lasse Holmstedt's avatar
Lasse Holmstedt committed
237 238 239 240
    if (!m_applicationLauncher.isRunning()) {
        showMessage(tr("Trying to stop while process is no longer running."), LogError);
    } else {
        disconnect(&m_applicationLauncher, SIGNAL(processExited(int)), this, SLOT(disconnected()));
241 242
        if (!m_attachToRunningExternalApp)
            m_applicationLauncher.stop();
Lasse Holmstedt's avatar
Lasse Holmstedt committed
243
    }
hjk's avatar
hjk committed
244 245 246 247 248 249
    notifyInferiorShutdownOk();
}

void QmlEngine::shutdownEngine()
{
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
Lasse Holmstedt's avatar
Lasse Holmstedt committed
250

251
    shutdownEngineAsSlave();
Lasse Holmstedt's avatar
Lasse Holmstedt committed
252

253
    notifyEngineShutdownOk();
254 255
}

hjk's avatar
hjk committed
256
void QmlEngine::setupEngine()
257
{
Lasse Holmstedt's avatar
Lasse Holmstedt committed
258 259 260 261 262 263
    m_adapter->setMaxConnectionAttempts(MaxConnectionAttempts);
    m_adapter->setConnectionAttemptInterval(ConnectionAttemptDefaultInterval);
    connect(m_adapter, SIGNAL(connectionError()), SLOT(connectionError()));
    connect(m_adapter, SIGNAL(connected()), SLOT(connectionEstablished()));
    connect(m_adapter, SIGNAL(connectionStartupFailed()), SLOT(connectionStartupFailed()));

264
    notifyEngineSetupOk();
265 266
}

267 268
void QmlEngine::continueInferior()
{
hjk's avatar
hjk committed
269
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
270 271 272 273
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("CONTINUE");
    sendMessage(reply);
274
    resetLocation();
hjk's avatar
hjk committed
275 276
    notifyInferiorRunRequested();
    notifyInferiorRunOk();
277 278 279 280
}

void QmlEngine::interruptInferior()
{
281 282 283 284
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("INTERRUPT");
    sendMessage(reply);
285
    notifyInferiorStopOk();
286 287 288 289
}

void QmlEngine::executeStep()
{
290 291 292 293
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("STEPINTO");
    sendMessage(reply);
hjk's avatar
hjk committed
294 295
    notifyInferiorRunRequested();
    notifyInferiorRunOk();
296 297 298 299
}

void QmlEngine::executeStepI()
{
300 301 302 303
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("STEPINTO");
    sendMessage(reply);
hjk's avatar
hjk committed
304 305
    notifyInferiorRunRequested();
    notifyInferiorRunOk();
306 307 308 309
}

void QmlEngine::executeStepOut()
{
310 311 312 313
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("STEPOUT");
    sendMessage(reply);
hjk's avatar
hjk committed
314 315
    notifyInferiorRunRequested();
    notifyInferiorRunOk();
316 317 318 319
}

void QmlEngine::executeNext()
{
320 321 322 323
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("STEPOVER");
    sendMessage(reply);
hjk's avatar
hjk committed
324 325
    notifyInferiorRunRequested();
    notifyInferiorRunOk();
326 327 328 329
}

void QmlEngine::executeNextI()
{
330
    SDEBUG("QmlEngine::executeNextI()");
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
}

void QmlEngine::executeRunToLine(const QString &fileName, int lineNumber)
{
    Q_UNUSED(fileName)
    Q_UNUSED(lineNumber)
    SDEBUG("FIXME:  QmlEngine::executeRunToLine()");
}

void QmlEngine::executeRunToFunction(const QString &functionName)
{
    Q_UNUSED(functionName)
    XSDEBUG("FIXME:  QmlEngine::executeRunToFunction()");
}

void QmlEngine::executeJumpToLine(const QString &fileName, int lineNumber)
{
    Q_UNUSED(fileName)
    Q_UNUSED(lineNumber)
    XSDEBUG("FIXME:  QmlEngine::executeJumpToLine()");
}

void QmlEngine::activateFrame(int index)
{
    Q_UNUSED(index)
356 357 358 359 360 361 362

    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("ACTIVATE_FRAME");
    rs << index;
    sendMessage(reply);

363
    gotoLocation(stackHandler()->frames().value(index), true);
364 365 366 367 368 369 370 371 372
}

void QmlEngine::selectThread(int index)
{
    Q_UNUSED(index)
}

void QmlEngine::attemptBreakpointSynchronization()
{
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    BreakHandler *handler = breakHandler();
    //bool updateNeeded = false;
    QSet< QPair<QString, qint32> > breakList;
    for (int index = 0; index != handler->size(); ++index) {
        BreakpointData *data = handler->at(index);
        breakList << qMakePair(data->fileName, data->lineNumber.toInt());
    }

    {
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("BREAKPOINTS");
    rs << breakList;
    //qDebug() << Q_FUNC_INFO << breakList;
    sendMessage(reply);
    }
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
}

void QmlEngine::loadSymbols(const QString &moduleName)
{
    Q_UNUSED(moduleName)
}

void QmlEngine::loadAllSymbols()
{
}

void QmlEngine::reloadModules()
{
}

void QmlEngine::requestModuleSymbols(const QString &moduleName)
{
    Q_UNUSED(moduleName)
}

//////////////////////////////////////////////////////////////////////
//
// Tooltip specific stuff
//
//////////////////////////////////////////////////////////////////////

static WatchData m_toolTip;
static QPoint m_toolTipPos;
static QHash<QString, WatchData> m_toolTipCache;

void QmlEngine::setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos)
{
    Q_UNUSED(mousePos)
    Q_UNUSED(editor)
    Q_UNUSED(cursorPos)
}

//////////////////////////////////////////////////////////////////////
//
// Watch specific stuff
//
//////////////////////////////////////////////////////////////////////

void QmlEngine::assignValueInDebugger(const QString &expression,
    const QString &value)
{
435 436 437 438 439 440 441 442 443 444 445 446 447
    QRegExp inObject("@([0-9a-fA-F]+)->(.+)");
    if (inObject.exactMatch(expression)) {
        bool ok = false;
        quint64 objectId = inObject.cap(1).toULongLong(&ok, 16);
        QString property = inObject.cap(2);
        if (ok && objectId > 0 && !property.isEmpty()) {
            QByteArray reply;
            QDataStream rs(&reply, QIODevice::WriteOnly);
            rs << QByteArray("SET_PROPERTY");
            rs << expression.toUtf8() << objectId << property << value;
            sendMessage(reply);
        }
    }
448 449
}

450
void QmlEngine::updateWatchData(const WatchData &data)
451
{
Olivier Goffart's avatar
Olivier Goffart committed
452
//    qDebug() << "UPDATE WATCH DATA" << data.toString();
453
    //watchHandler()->rebuildModel();
454
    showStatusMessage(tr("Stopped."), 5000);
455

456
    if (!data.name.isEmpty() && data.isValueNeeded()) {
457 458 459 460 461 462 463
        QByteArray reply;
        QDataStream rs(&reply, QIODevice::WriteOnly);
        rs << QByteArray("EXEC");
        rs << data.iname << data.name;
        sendMessage(reply);
    }

464 465
    if (!data.name.isEmpty() && data.isChildrenNeeded()
            && watchHandler()->isExpandedIName(data.iname))
466 467
        expandObject(data.iname, data.objectId);

468 469 470 471 472 473 474
    {
        QByteArray reply;
        QDataStream rs(&reply, QIODevice::WriteOnly);
        rs << QByteArray("WATCH_EXPRESSIONS");
        rs << watchHandler()->watchedExpressions();
        sendMessage(reply);
    }
475 476 477

    if (!data.isSomethingNeeded())
        watchHandler()->insertData(data);
478 479
}

480 481 482 483 484 485 486 487 488
void QmlEngine::expandObject(const QByteArray& iname, quint64 objectId)
{
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("EXPAND");
    rs << iname << objectId;
    sendMessage(reply);
}

489 490 491 492 493 494 495 496 497 498
void QmlEngine::sendPing()
{
    m_ping++;
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("PING");
    rs << m_ping;
    sendMessage(reply);
}

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
DebuggerEngine *createQmlEngine(const DebuggerStartParameters &sp)
{
    return new QmlEngine(sp);
}

unsigned QmlEngine::debuggerCapabilities() const
{
    return AddWatcherCapability;
    /*ReverseSteppingCapability | SnapshotCapability
        | AutoDerefPointersCapability | DisassemblerCapability
        | RegisterCapability | ShowMemoryCapability
        | JumpToLineCapability | ReloadModuleCapability
        | ReloadModuleSymbolsCapability | BreakOnThrowAndCatchCapability
        | ReturnFromFunctionCapability
        | CreateFullBacktraceCapability
        | WatchpointCapability
        | AddWatcherCapability;*/
516 517 518 519 520 521 522 523 524 525
}

void QmlEngine::messageReceived(const QByteArray &message)
{
    QByteArray rwData = message;
    QDataStream stream(&rwData, QIODevice::ReadOnly);

    QByteArray command;
    stream >> command;

526
    showMessage(_("RECEIVED RESPONSE: ") + quoteUnprintableLatin1(message));
527
    if (command == "STOPPED") {
528 529 530
        if (state() == InferiorRunOk) {
            notifyInferiorSpontaneousStop();
        }
531

532
        QList<QPair<QString, QPair<QString, qint32> > > backtrace;
533 534
        QList<WatchData> watches;
        QList<WatchData> locals;
535
        stream >> backtrace >> watches >> locals;
536

537
        StackFrames stackFrames;
538 539 540 541 542 543
        typedef QPair<QString, QPair<QString, qint32> > Iterator;
        foreach (const Iterator &it, backtrace) {
            StackFrame frame;
            frame.file = it.second.first;
            frame.line = it.second.second;
            frame.function = it.first;
544
            stackFrames.append(frame);
545 546 547 548 549 550
        }

        gotoLocation(stackFrames.value(0), true);
        stackHandler()->setFrames(stackFrames);

        watchHandler()->beginCycle();
551
        bool needPing = false;
552

553
        foreach (WatchData data, watches) {
554
            data.iname = watchHandler()->watcherName(data.exp);
555
            watchHandler()->insertData(data);
556

557 558
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
559
                expandObject(data.iname, data.objectId);
560
            }
561 562
        }

563 564 565
        foreach (WatchData data, locals) {
            data.iname = "local." + data.exp;
            watchHandler()->insertData(data);
566

567 568
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
569
                expandObject(data.iname, data.objectId);
570
            }
hjk's avatar
hjk committed
571 572
        }

573 574 575 576
        if (needPing)
            sendPing();
        else
            watchHandler()->endCycle();
577

578 579 580
        bool becauseOfException;
        stream >> becauseOfException;
        if (becauseOfException) {
581 582 583
            QString error;
            stream >> error;

584 585 586
            QString msg =
                tr("<p>An Uncaught Exception occured in <i>%1</i>:</p><p>%2</p>")
                    .arg(stackFrames.value(0).file, Qt::escape(error));
587 588 589
            showMessageBox(QMessageBox::Information, tr("Uncaught Exception"), msg);
        }

590

591 592
    } else if (command == "RESULT") {
        WatchData data;
593 594 595
        QByteArray iname;
        stream >> iname >> data;
        data.iname = iname;
596
        watchHandler()->insertData(data);
597 598 599 600 601

    } else if (command == "EXPANDED") {
        QList<WatchData> result;
        QByteArray iname;
        stream >> iname >> result;
602
        bool needPing = false;
603 604 605 606
        foreach (WatchData data, result) {
            data.iname = iname + '.' + data.exp;
            watchHandler()->insertData(data);

607 608
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
609
                expandObject(data.iname, data.objectId);
610
            }
611
        }
612 613
        if (needPing)
            sendPing();
614 615 616 617 618
    } else if (command == "LOCALS") {
        QList<WatchData> locals;
        int frameId;
        stream >> frameId >> locals;
        watchHandler()->beginCycle();
619
        bool needPing = false;
620 621 622
        foreach (WatchData data, locals) {
            data.iname = "local." + data.exp;
            watchHandler()->insertData(data);
623 624
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
625
                expandObject(data.iname, data.objectId);
626
            }
627
        }
628 629 630 631 632 633 634 635 636 637
        if (needPing)
            sendPing();
        else
            watchHandler()->endCycle();

    } else if (command == "PONG") {
        int ping;
        stream >> ping;
        if (ping == m_ping)
            watchHandler()->endCycle();
638 639 640 641 642 643
    } else {
        qDebug() << Q_FUNC_INFO << "Unknown command: " << command;
    }

}

644 645
void QmlEngine::disconnected()
{
Lasse Holmstedt's avatar
Lasse Holmstedt committed
646
    plugin()->showMessage(tr("QML Debugger disconnected."), StatusBar);
647 648 649
    notifyInferiorExited();
}

650 651 652 653 654 655 656 657 658
void QmlEngine::slotAddToOutputWindow(QString line, bool onStdErr)
{
    emit runControl()->addToOutputWindowInline(runControl(), line, onStdErr);
}

void QmlEngine::slotMessage(QString err , bool isError)
{
    emit runControl()->appendMessage(runControl(), err, isError);
}
659

660 661
} // namespace Internal
} // namespace Debugger
662