qmlengine.cpp 17.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/**************************************************************************
**
** 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

39 40 41 42 43 44 45
#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
46
#include <extensionsystem/pluginmanager.h>
47 48
#include <projectexplorer/environment.h>

49 50 51 52 53 54 55 56 57 58 59 60 61
#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>
62
#include <QtGui/QTextDocument>
63 64

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

67 68 69 70 71 72 73 74
#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
75 76
enum {
    MaxConnectionAttempts = 50,
77
    ConnectionAttemptDefaultInterval = 200
Lasse Holmstedt's avatar
Lasse Holmstedt committed
78
};
79

80 81 82
namespace Debugger {
namespace Internal {

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

97 98 99 100 101 102
///////////////////////////////////////////////////////////////////////
//
// QmlEngine
//
///////////////////////////////////////////////////////////////////////

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

QmlEngine::~QmlEngine()
{
}

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

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

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

    connect(&m_applicationLauncher, SIGNAL(processExited(int)), SLOT(disconnected()));
    m_applicationLauncher.setEnvironment(startParameters().environment);
    m_applicationLauncher.setWorkingDirectory(startParameters().workingDirectory);

hjk's avatar
hjk committed
136 137
    notifyInferiorSetupOk();
}
hjk's avatar
hjk committed
138

Lasse Holmstedt's avatar
Lasse Holmstedt committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
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
165 166 167
void QmlEngine::runEngine()
{
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
Lasse Holmstedt's avatar
Lasse Holmstedt committed
168

169 170 171 172 173
    if (!m_attachToRunningExternalApp) {
        m_applicationLauncher.start(ProjectExplorer::ApplicationLauncher::Gui,
                                    startParameters().executable,
                                    startParameters().processArgs);
    }
Lasse Holmstedt's avatar
Lasse Holmstedt committed
174 175 176

    m_adapter->beginConnection();
    plugin()->showMessage(tr("QML Debugger connecting..."), StatusBar);
177 178 179 180 181
}

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

183 184 185 186 187 188 189 190 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
    // 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;
219 220
}

hjk's avatar
hjk committed
221
void QmlEngine::shutdownInferior()
222
{
223 224 225 226
    // don't do normal shutdown if running as slave engine
    if (m_attachToRunningExternalApp)
        return;

hjk's avatar
hjk committed
227
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
Lasse Holmstedt's avatar
Lasse Holmstedt committed
228 229 230 231
    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()));
232 233
        if (!m_attachToRunningExternalApp)
            m_applicationLauncher.stop();
Lasse Holmstedt's avatar
Lasse Holmstedt committed
234
    }
hjk's avatar
hjk committed
235 236 237 238 239 240
    notifyInferiorShutdownOk();
}

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

242
    shutdownEngineAsSlave();
Lasse Holmstedt's avatar
Lasse Holmstedt committed
243

244
    notifyEngineShutdownOk();
245 246
}

hjk's avatar
hjk committed
247
void QmlEngine::setupEngine()
248
{
Lasse Holmstedt's avatar
Lasse Holmstedt committed
249 250 251 252 253 254
    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()));

255
    notifyEngineSetupOk();
256 257
}

258 259
void QmlEngine::continueInferior()
{
hjk's avatar
hjk committed
260
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
261 262 263 264
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("CONTINUE");
    sendMessage(reply);
265
    resetLocation();
hjk's avatar
hjk committed
266 267
    notifyInferiorRunRequested();
    notifyInferiorRunOk();
268 269 270 271
}

void QmlEngine::interruptInferior()
{
272 273 274 275
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("INTERRUPT");
    sendMessage(reply);
276
    notifyInferiorStopOk();
277 278 279 280
}

void QmlEngine::executeStep()
{
281 282 283 284
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("STEPINTO");
    sendMessage(reply);
hjk's avatar
hjk committed
285 286
    notifyInferiorRunRequested();
    notifyInferiorRunOk();
287 288 289 290
}

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

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

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

void QmlEngine::executeNextI()
{
321
    SDEBUG("QmlEngine::executeNextI()");
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
}

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)
347 348 349 350 351 352 353

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

354
    gotoLocation(stackHandler()->frames().value(index), true);
355 356 357 358 359 360 361 362 363
}

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

void QmlEngine::attemptBreakpointSynchronization()
{
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    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);
    }
380 381 382 383 384 385 386 387 388 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
}

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)
{
426 427 428 429 430 431 432 433 434 435 436 437 438
    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);
        }
    }
439 440
}

441
void QmlEngine::updateWatchData(const WatchData &data)
442
{
Olivier Goffart's avatar
Olivier Goffart committed
443
//    qDebug() << "UPDATE WATCH DATA" << data.toString();
444
    //watchHandler()->rebuildModel();
445
    showStatusMessage(tr("Stopped."), 5000);
446

447
    if (!data.name.isEmpty() && data.isValueNeeded()) {
448 449 450 451 452 453 454
        QByteArray reply;
        QDataStream rs(&reply, QIODevice::WriteOnly);
        rs << QByteArray("EXEC");
        rs << data.iname << data.name;
        sendMessage(reply);
    }

455 456
    if (!data.name.isEmpty() && data.isChildrenNeeded()
            && watchHandler()->isExpandedIName(data.iname))
457 458
        expandObject(data.iname, data.objectId);

459 460 461 462 463 464 465
    {
        QByteArray reply;
        QDataStream rs(&reply, QIODevice::WriteOnly);
        rs << QByteArray("WATCH_EXPRESSIONS");
        rs << watchHandler()->watchedExpressions();
        sendMessage(reply);
    }
466 467 468

    if (!data.isSomethingNeeded())
        watchHandler()->insertData(data);
469 470
}

471 472 473 474 475 476 477 478 479
void QmlEngine::expandObject(const QByteArray& iname, quint64 objectId)
{
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("EXPAND");
    rs << iname << objectId;
    sendMessage(reply);
}

480 481 482 483 484 485 486 487 488 489
void QmlEngine::sendPing()
{
    m_ping++;
    QByteArray reply;
    QDataStream rs(&reply, QIODevice::WriteOnly);
    rs << QByteArray("PING");
    rs << m_ping;
    sendMessage(reply);
}

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
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;*/
507 508 509 510 511 512 513 514 515 516
}

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

    QByteArray command;
    stream >> command;

517
    showMessage(_("RECEIVED RESPONSE: ") + quoteUnprintableLatin1(message));
518
    if (command == "STOPPED") {
519 520 521
        if (state() == InferiorRunOk) {
            notifyInferiorSpontaneousStop();
        }
522

523
        QList<QPair<QString, QPair<QString, qint32> > > backtrace;
524 525
        QList<WatchData> watches;
        QList<WatchData> locals;
526
        stream >> backtrace >> watches >> locals;
527

528
        StackFrames stackFrames;
529 530 531 532 533 534
        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;
535
            stackFrames.append(frame);
536 537 538 539 540 541
        }

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

        watchHandler()->beginCycle();
542
        bool needPing = false;
543

544
        foreach (WatchData data, watches) {
545
            data.iname = watchHandler()->watcherName(data.exp);
546
            watchHandler()->insertData(data);
547

548 549
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
550
                expandObject(data.iname, data.objectId);
551
            }
552 553
        }

554 555 556
        foreach (WatchData data, locals) {
            data.iname = "local." + data.exp;
            watchHandler()->insertData(data);
557

558 559
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
560
                expandObject(data.iname, data.objectId);
561
            }
hjk's avatar
hjk committed
562 563
        }

564 565 566 567
        if (needPing)
            sendPing();
        else
            watchHandler()->endCycle();
568

569 570 571
        bool becauseOfException;
        stream >> becauseOfException;
        if (becauseOfException) {
572 573 574
            QString error;
            stream >> error;

575 576 577
            QString msg =
                tr("<p>An Uncaught Exception occured in <i>%1</i>:</p><p>%2</p>")
                    .arg(stackFrames.value(0).file, Qt::escape(error));
578 579 580
            showMessageBox(QMessageBox::Information, tr("Uncaught Exception"), msg);
        }

581

582 583
    } else if (command == "RESULT") {
        WatchData data;
584 585 586
        QByteArray iname;
        stream >> iname >> data;
        data.iname = iname;
587
        watchHandler()->insertData(data);
588 589 590 591 592

    } else if (command == "EXPANDED") {
        QList<WatchData> result;
        QByteArray iname;
        stream >> iname >> result;
593
        bool needPing = false;
594 595 596 597
        foreach (WatchData data, result) {
            data.iname = iname + '.' + data.exp;
            watchHandler()->insertData(data);

598 599
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
600
                expandObject(data.iname, data.objectId);
601
            }
602
        }
603 604
        if (needPing)
            sendPing();
605 606 607 608 609
    } else if (command == "LOCALS") {
        QList<WatchData> locals;
        int frameId;
        stream >> frameId >> locals;
        watchHandler()->beginCycle();
610
        bool needPing = false;
611 612 613
        foreach (WatchData data, locals) {
            data.iname = "local." + data.exp;
            watchHandler()->insertData(data);
614 615
            if (watchHandler()->expandedINames().contains(data.iname)) {
                needPing = true;
616
                expandObject(data.iname, data.objectId);
617
            }
618
        }
619 620 621 622 623 624 625 626 627 628
        if (needPing)
            sendPing();
        else
            watchHandler()->endCycle();

    } else if (command == "PONG") {
        int ping;
        stream >> ping;
        if (ping == m_ping)
            watchHandler()->endCycle();
629 630 631 632 633 634
    } else {
        qDebug() << Q_FUNC_INFO << "Unknown command: " << command;
    }

}

635 636
void QmlEngine::disconnected()
{
Lasse Holmstedt's avatar
Lasse Holmstedt committed
637
    plugin()->showMessage(tr("QML Debugger disconnected."), StatusBar);
638 639 640 641
    notifyInferiorExited();
}


642 643
} // namespace Internal
} // namespace Debugger
644