forked from qt-creator/qt-creator
QmlDebug: Rename library and (most) classes
Rename the QmlJSDebugClient lib to QmlDebug (shorter names, easier differentiation with the shared/qmljsdebug lib). Also rename - QDeclarativeDebug* classes to QmlDebug* - QDeclarativeOutputParser class to QmlOutputParser To clarify the features, - Debugger::QmlDebuggerClient is now Debugger::BaseQmlDebuggerClient - QmlEngineDebugClient is now BaseEngineDebugClient - QmlDebuggerClient is now QmlEngineDebugClient - QDeclarativeEngineDebugClient is now DeclarativeEngineDebugClient Change-Id: Ie15713730a614c8ab4b637fad0924f95b54e633f Reviewed-by: Aurindam Jana <aurindam.jana@nokia.com>
This commit is contained in:
Kai Koehne
453
src/libs/qmldebug/qmldebugclient.cpp
Normal file
453
src/libs/qmldebug/qmldebugclient.cpp
Normal file
@@ -0,0 +1,453 @@
|
||||
/**************************************************************************
|
||||
**
|
||||
** This file is part of Qt Creator
|
||||
**
|
||||
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
|
||||
**
|
||||
** Contact: Nokia Corporation (qt-info@nokia.com)
|
||||
**
|
||||
** GNU Lesser General Public License Usage
|
||||
**
|
||||
** 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.
|
||||
**
|
||||
** In addition, as a special exception, Nokia gives you certain additional
|
||||
** rights. These rights are described in the Nokia Qt LGPL Exception
|
||||
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
||||
**
|
||||
** Other Usage
|
||||
**
|
||||
** Alternatively, this file may be used in accordance with the terms and
|
||||
** conditions contained in a signed written agreement between you and Nokia.
|
||||
**
|
||||
** If you have questions regarding the use of this file, please contact
|
||||
** Nokia at qt-info@nokia.com.
|
||||
**
|
||||
**************************************************************************/
|
||||
|
||||
#include "qmldebugclient.h"
|
||||
|
||||
#include "qpacketprotocol.h"
|
||||
|
||||
#include <qdebug.h>
|
||||
#include <qstringlist.h>
|
||||
#include <qnetworkproxy.h>
|
||||
#include <symbiandevicemanager.h>
|
||||
|
||||
namespace QmlDebug {
|
||||
|
||||
const int protocolVersion = 1;
|
||||
const QString serverId = QLatin1String("QDeclarativeDebugServer");
|
||||
const QString clientId = QLatin1String("QDeclarativeDebugClient");
|
||||
static const uchar KQmlOstProtocolId = 0x94;
|
||||
|
||||
class QmlDebugClientPrivate
|
||||
{
|
||||
// Q_DECLARE_PUBLIC(QmlDebugClient)
|
||||
public:
|
||||
QmlDebugClientPrivate();
|
||||
|
||||
QString name;
|
||||
QmlDebugConnection *connection;
|
||||
};
|
||||
|
||||
class QmlDebugConnectionPrivate : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
public:
|
||||
QmlDebugConnectionPrivate(QmlDebugConnection *c);
|
||||
QmlDebugConnection *q;
|
||||
QPacketProtocol *protocol;
|
||||
QIODevice *device; // Currently either a QTcpSocket or a SymbianUtils::OstChannel
|
||||
|
||||
bool gotHello;
|
||||
QHash <QString, float> serverPlugins;
|
||||
QHash<QString, QmlDebugClient *> plugins;
|
||||
|
||||
void advertisePlugins();
|
||||
void connectDeviceSignals();
|
||||
|
||||
public Q_SLOTS:
|
||||
void connected();
|
||||
void readyRead();
|
||||
void deviceAboutToClose();
|
||||
};
|
||||
|
||||
QmlDebugConnectionPrivate::QmlDebugConnectionPrivate(QmlDebugConnection *c)
|
||||
: QObject(c), q(c), protocol(0), device(0), gotHello(false)
|
||||
{
|
||||
protocol = new QPacketProtocol(q, this);
|
||||
QObject::connect(c, SIGNAL(connected()), this, SLOT(connected()));
|
||||
QObject::connect(protocol, SIGNAL(readyRead()), this, SLOT(readyRead()));
|
||||
}
|
||||
|
||||
void QmlDebugConnectionPrivate::advertisePlugins()
|
||||
{
|
||||
if (!q->isConnected() || !gotHello)
|
||||
return;
|
||||
|
||||
QPacket pack;
|
||||
pack << serverId << 1 << plugins.keys();
|
||||
protocol->send(pack);
|
||||
q->flush();
|
||||
}
|
||||
|
||||
void QmlDebugConnectionPrivate::connected()
|
||||
{
|
||||
QPacket pack;
|
||||
pack << serverId << 0 << protocolVersion << plugins.keys();
|
||||
protocol->send(pack);
|
||||
q->flush();
|
||||
}
|
||||
|
||||
void QmlDebugConnectionPrivate::readyRead()
|
||||
{
|
||||
if (!gotHello) {
|
||||
QPacket pack = protocol->read();
|
||||
QString name;
|
||||
|
||||
pack >> name;
|
||||
|
||||
bool validHello = false;
|
||||
if (name == clientId) {
|
||||
int op = -1;
|
||||
pack >> op;
|
||||
if (op == 0) {
|
||||
int version = -1;
|
||||
pack >> version;
|
||||
if (version == protocolVersion) {
|
||||
QStringList pluginNames;
|
||||
QList<float> pluginVersions;
|
||||
pack >> pluginNames;
|
||||
if (!pack.isEmpty())
|
||||
pack >> pluginVersions;
|
||||
|
||||
const int pluginNamesSize = pluginNames.size();
|
||||
const int pluginVersionsSize = pluginVersions.size();
|
||||
for (int i = 0; i < pluginNamesSize; ++i) {
|
||||
float pluginVersion = 1.0;
|
||||
if (i < pluginVersionsSize)
|
||||
pluginVersion = pluginVersions.at(i);
|
||||
serverPlugins.insert(pluginNames.at(i), pluginVersion);
|
||||
}
|
||||
|
||||
validHello = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!validHello) {
|
||||
qWarning("QML Debug Client: Invalid hello message");
|
||||
QObject::disconnect(protocol, SIGNAL(readyRead()), this, SLOT(readyRead()));
|
||||
return;
|
||||
}
|
||||
gotHello = true;
|
||||
|
||||
QHash<QString, QmlDebugClient *>::Iterator iter = plugins.begin();
|
||||
for (; iter != plugins.end(); ++iter) {
|
||||
QmlDebugClient::Status newStatus = QmlDebugClient::Unavailable;
|
||||
if (serverPlugins.contains(iter.key()))
|
||||
newStatus = QmlDebugClient::Enabled;
|
||||
iter.value()->statusChanged(newStatus);
|
||||
}
|
||||
}
|
||||
|
||||
while (protocol->packetsAvailable()) {
|
||||
QPacket pack = protocol->read();
|
||||
QString name;
|
||||
pack >> name;
|
||||
|
||||
if (name == clientId) {
|
||||
int op = -1;
|
||||
pack >> op;
|
||||
|
||||
if (op == 1) {
|
||||
// Service Discovery
|
||||
QHash<QString, float> oldServerPlugins = serverPlugins;
|
||||
serverPlugins.clear();
|
||||
|
||||
QStringList pluginNames;
|
||||
QList<float> pluginVersions;
|
||||
pack >> pluginNames;
|
||||
if (!pack.isEmpty())
|
||||
pack >> pluginVersions;
|
||||
|
||||
const int pluginNamesSize = pluginNames.size();
|
||||
const int pluginVersionsSize = pluginVersions.size();
|
||||
for (int i = 0; i < pluginNamesSize; ++i) {
|
||||
float pluginVersion = 1.0;
|
||||
if (i < pluginVersionsSize)
|
||||
pluginVersion = pluginVersions.at(i);
|
||||
serverPlugins.insert(pluginNames.at(i), pluginVersion);
|
||||
}
|
||||
|
||||
QHash<QString, QmlDebugClient *>::Iterator iter = plugins.begin();
|
||||
for (; iter != plugins.end(); ++iter) {
|
||||
const QString pluginName = iter.key();
|
||||
QmlDebugClient::Status newStatus = QmlDebugClient::Unavailable;
|
||||
if (serverPlugins.contains(pluginName))
|
||||
newStatus = QmlDebugClient::Enabled;
|
||||
|
||||
if (oldServerPlugins.contains(pluginName)
|
||||
!= serverPlugins.contains(pluginName)) {
|
||||
iter.value()->statusChanged(newStatus);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
qWarning() << "QML Debug Client: Unknown control message id" << op;
|
||||
}
|
||||
} else {
|
||||
QByteArray message;
|
||||
pack >> message;
|
||||
|
||||
QHash<QString, QmlDebugClient *>::Iterator iter =
|
||||
plugins.find(name);
|
||||
if (iter == plugins.end()) {
|
||||
qWarning() << "QML Debug Client: Message received for missing plugin" << name;
|
||||
} else {
|
||||
(*iter)->messageReceived(message);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void QmlDebugConnectionPrivate::deviceAboutToClose()
|
||||
{
|
||||
// This is nasty syntax but we want to emit our own aboutToClose signal (by calling QIODevice::close())
|
||||
// without calling the underlying device close fn as that would cause an infinite loop
|
||||
q->QIODevice::close();
|
||||
}
|
||||
|
||||
QmlDebugConnection::QmlDebugConnection(QObject *parent)
|
||||
: QIODevice(parent), d(new QmlDebugConnectionPrivate(this))
|
||||
{
|
||||
}
|
||||
|
||||
QmlDebugConnection::~QmlDebugConnection()
|
||||
{
|
||||
QHash<QString, QmlDebugClient*>::iterator iter = d->plugins.begin();
|
||||
for (; iter != d->plugins.end(); ++iter) {
|
||||
iter.value()->d_func()->connection = 0;
|
||||
iter.value()->statusChanged(QmlDebugClient::NotConnected);
|
||||
}
|
||||
}
|
||||
|
||||
bool QmlDebugConnection::isConnected() const
|
||||
{
|
||||
return state() == QAbstractSocket::ConnectedState;
|
||||
}
|
||||
|
||||
qint64 QmlDebugConnection::readData(char *data, qint64 maxSize)
|
||||
{
|
||||
return d->device->read(data, maxSize);
|
||||
}
|
||||
|
||||
qint64 QmlDebugConnection::writeData(const char *data, qint64 maxSize)
|
||||
{
|
||||
return d->device->write(data, maxSize);
|
||||
}
|
||||
|
||||
void QmlDebugConnection::internalError(QAbstractSocket::SocketError socketError)
|
||||
{
|
||||
setErrorString(d->device->errorString());
|
||||
emit error(socketError);
|
||||
}
|
||||
|
||||
qint64 QmlDebugConnection::bytesAvailable() const
|
||||
{
|
||||
return d->device->bytesAvailable();
|
||||
}
|
||||
|
||||
bool QmlDebugConnection::isSequential() const
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
void QmlDebugConnection::close()
|
||||
{
|
||||
if (isOpen()) {
|
||||
QIODevice::close();
|
||||
d->device->close();
|
||||
emit stateChanged(QAbstractSocket::UnconnectedState);
|
||||
|
||||
QHash<QString, QmlDebugClient*>::iterator iter = d->plugins.begin();
|
||||
for (; iter != d->plugins.end(); ++iter) {
|
||||
iter.value()->statusChanged(QmlDebugClient::NotConnected);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bool QmlDebugConnection::waitForConnected(int msecs)
|
||||
{
|
||||
QAbstractSocket *socket = qobject_cast<QAbstractSocket*>(d->device);
|
||||
if (socket)
|
||||
return socket->waitForConnected(msecs);
|
||||
return false;
|
||||
}
|
||||
|
||||
// For ease of refactoring we use QAbstractSocket's states even if we're actually using a OstChannel underneath
|
||||
// since serial ports have a subset of the socket states afaics
|
||||
QAbstractSocket::SocketState QmlDebugConnection::state() const
|
||||
{
|
||||
QAbstractSocket *socket = qobject_cast<QAbstractSocket*>(d->device);
|
||||
if (socket)
|
||||
return socket->state();
|
||||
|
||||
SymbianUtils::OstChannel *ost = qobject_cast<SymbianUtils::OstChannel*>(d->device);
|
||||
if (ost) {
|
||||
//TODO we need some handshaking here
|
||||
/*
|
||||
if (ost->hasReceivedData())
|
||||
return QAbstractSocket::ConnectedState;
|
||||
else if (ost->isOpen())
|
||||
return QAbstractSocket::ConnectingState;
|
||||
*/
|
||||
if (ost->isOpen()) return QAbstractSocket::ConnectedState;
|
||||
}
|
||||
|
||||
return QAbstractSocket::UnconnectedState;
|
||||
}
|
||||
|
||||
void QmlDebugConnection::flush()
|
||||
{
|
||||
QAbstractSocket *socket = qobject_cast<QAbstractSocket*>(d->device);
|
||||
if (socket) {
|
||||
socket->flush();
|
||||
return;
|
||||
}
|
||||
|
||||
SymbianUtils::OstChannel *ost = qobject_cast<SymbianUtils::OstChannel*>(d->device);
|
||||
if (ost) {
|
||||
ost->flush();
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
void QmlDebugConnection::connectToHost(const QString &hostName, quint16 port)
|
||||
{
|
||||
QTcpSocket *socket = new QTcpSocket(d);
|
||||
socket->setProxy(QNetworkProxy::NoProxy);
|
||||
d->device = socket;
|
||||
d->connectDeviceSignals();
|
||||
d->gotHello = false;
|
||||
connect(socket, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SIGNAL(stateChanged(QAbstractSocket::SocketState)));
|
||||
connect(socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(internalError(QAbstractSocket::SocketError)));
|
||||
connect(socket, SIGNAL(connected()), this, SIGNAL(connected()));
|
||||
socket->connectToHost(hostName, port);
|
||||
QIODevice::open(ReadWrite | Unbuffered);
|
||||
}
|
||||
|
||||
void QmlDebugConnection::connectToOst(const QString &port)
|
||||
{
|
||||
SymbianUtils::OstChannel *ost = SymbianUtils::SymbianDeviceManager::instance()->getOstChannel(port, KQmlOstProtocolId);
|
||||
if (ost) {
|
||||
ost->setParent(d);
|
||||
d->device = ost;
|
||||
d->connectDeviceSignals();
|
||||
d->gotHello = false;
|
||||
QIODevice::open(ReadWrite | Unbuffered);
|
||||
emit stateChanged(QAbstractSocket::ConnectedState);
|
||||
emit connected();
|
||||
} else {
|
||||
emit error(QAbstractSocket::HostNotFoundError);
|
||||
}
|
||||
}
|
||||
|
||||
void QmlDebugConnectionPrivate::connectDeviceSignals()
|
||||
{
|
||||
connect(device, SIGNAL(bytesWritten(qint64)), q, SIGNAL(bytesWritten(qint64)));
|
||||
connect(device, SIGNAL(readyRead()), q, SIGNAL(readyRead()));
|
||||
connect(device, SIGNAL(aboutToClose()), this, SLOT(deviceAboutToClose()));
|
||||
}
|
||||
|
||||
//
|
||||
|
||||
QmlDebugClientPrivate::QmlDebugClientPrivate()
|
||||
: connection(0)
|
||||
{
|
||||
}
|
||||
|
||||
QmlDebugClient::QmlDebugClient(const QString &name,
|
||||
QmlDebugConnection *parent)
|
||||
: QObject(parent), d_ptr(new QmlDebugClientPrivate())
|
||||
{
|
||||
Q_D(QmlDebugClient);
|
||||
d->name = name;
|
||||
d->connection = parent;
|
||||
|
||||
if (!d->connection)
|
||||
return;
|
||||
|
||||
if (d->connection->d->plugins.contains(name)) {
|
||||
qWarning() << "QML Debug Client: Conflicting plugin name" << name;
|
||||
d->connection = 0;
|
||||
} else {
|
||||
d->connection->d->plugins.insert(name, this);
|
||||
d->connection->d->advertisePlugins();
|
||||
}
|
||||
}
|
||||
|
||||
QmlDebugClient::~QmlDebugClient()
|
||||
{
|
||||
Q_D(const QmlDebugClient);
|
||||
if (d->connection && d->connection->d) {
|
||||
d->connection->d->plugins.remove(d->name);
|
||||
d->connection->d->advertisePlugins();
|
||||
}
|
||||
}
|
||||
|
||||
QString QmlDebugClient::name() const
|
||||
{
|
||||
Q_D(const QmlDebugClient);
|
||||
return d->name;
|
||||
}
|
||||
|
||||
float QmlDebugClient::serviceVersion() const
|
||||
{
|
||||
Q_D(const QmlDebugClient);
|
||||
if (d->connection && d->connection->d->serverPlugins.contains(d->name))
|
||||
return d->connection->d->serverPlugins.value(d->name);
|
||||
return -1;
|
||||
}
|
||||
|
||||
QmlDebugClient::Status QmlDebugClient::status() const
|
||||
{
|
||||
Q_D(const QmlDebugClient);
|
||||
if (!d->connection
|
||||
|| !d->connection->isConnected()
|
||||
|| !d->connection->d->gotHello)
|
||||
return NotConnected;
|
||||
|
||||
if (d->connection->d->serverPlugins.contains(d->name))
|
||||
return Enabled;
|
||||
|
||||
return Unavailable;
|
||||
}
|
||||
|
||||
void QmlDebugClient::sendMessage(const QByteArray &message)
|
||||
{
|
||||
Q_D(QmlDebugClient);
|
||||
if (status() != Enabled)
|
||||
return;
|
||||
|
||||
QPacket pack;
|
||||
pack << d->name << message;
|
||||
d->connection->d->protocol->send(pack);
|
||||
d->connection->flush();
|
||||
}
|
||||
|
||||
void QmlDebugClient::statusChanged(Status)
|
||||
{
|
||||
}
|
||||
|
||||
void QmlDebugClient::messageReceived(const QByteArray &)
|
||||
{
|
||||
}
|
||||
|
||||
} // namespace QmlDebug
|
||||
|
||||
#include <qmldebugclient.moc>
|
||||
Reference in New Issue
Block a user