src/declarative/qml/qdeclarativeenginedebug_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVEENGINEDEBUG_P_H
  43 #define QDECLARATIVEENGINEDEBUG_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <private/qdeclarativedebugservice_p.h>
  57
  58 #include <QtCore/qurl.h>
  59 #include <QtCore/qvariant.h>
  60 #include <QWeakPointer>
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 class QDeclarativeEngine;
  65 class QDeclarativeContext;
  66 class QDeclarativeWatcher;
  67 class QDataStream;
  68 class QDeclarativeState;
  69
  70 class QDeclarativeEngineDebugServer : public QDeclarativeDebugService
  71 {
  72     Q_OBJECT
  73 public:
  74     QDeclarativeEngineDebugServer(QObject * = 0);
  75
  76     struct QDeclarativeObjectData {
  77         QUrl url;
  78         int lineNumber;
  79         int columnNumber;
  80         QString idString;
  81         QString objectName;
  82         QString objectType;
  83         int objectId;
  84         int contextId;
  85     };
  86
  87     struct QDeclarativeObjectProperty {
  88         enum Type { Unknown, Basic, Object, List, SignalProperty };
  89         Type type;
  90         QString name;
  91         QVariant value;
  92         QString valueTypeName;
  93         QString binding;
  94         bool hasNotifySignal;
  95     };
  96
  97     void addEngine(QDeclarativeEngine *);
  98     void remEngine(QDeclarativeEngine *);
  99     void objectCreated(QDeclarativeEngine *, QObject *);
 100
 101     static QDeclarativeEngineDebugServer *instance();
 102
 103 protected:
 104     virtual void messageReceived(const QByteArray &);
 105
 106 private Q_SLOTS:
 107     void propertyChanged(int id, int objectId, const QMetaProperty &property, const QVariant &value);
 108
 109 private:
 110     void prepareDeferredObjects(QObject *);
 111     void buildObjectList(QDataStream &, QDeclarativeContext *);
 112     void buildObjectDump(QDataStream &, QObject *, bool, bool);
 113     void buildStatesList(QDeclarativeContext *, bool);
 114     void buildStatesList(QObject *obj);
 115     QDeclarativeObjectData objectData(QObject *);
 116     QDeclarativeObjectProperty propertyData(QObject *, int);
 117     QVariant valueContents(const QVariant &defaultValue) const;
 118     void setBinding(int objectId, const QString &propertyName, const QVariant &expression, bool isLiteralValue, QString filename = QString(), int line = -1);
 119     void resetBinding(int objectId, const QString &propertyName);
 120     void setMethodBody(int objectId, const QString &method, const QString &body);
 121
 122     QList<QDeclarativeEngine *> m_engines;
 123     QDeclarativeWatcher *m_watch;
 124     QList<QWeakPointer<QDeclarativeState> > m_allStates;
 125 };
 126 Q_DECLARATIVE_PRIVATE_EXPORT QDataStream &operator<<(QDataStream &, const QDeclarativeEngineDebugServer::QDeclarativeObjectData &);
 127 Q_DECLARATIVE_PRIVATE_EXPORT QDataStream &operator>>(QDataStream &, QDeclarativeEngineDebugServer::QDeclarativeObjectData &);
 128 Q_DECLARATIVE_PRIVATE_EXPORT QDataStream &operator<<(QDataStream &, const QDeclarativeEngineDebugServer::QDeclarativeObjectProperty &);
 129 Q_DECLARATIVE_PRIVATE_EXPORT QDataStream &operator>>(QDataStream &, QDeclarativeEngineDebugServer::QDeclarativeObjectProperty &);
 130
 131 QT_END_NAMESPACE
 132
 133 #endif // QDECLARATIVEENGINEDEBUG_P_H
 134