src/qml/debugger/qqmlenginedebugservice_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLENGINEDEBUGSERVICE_P_H
  43 #define QQMLENGINEDEBUGSERVICE_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/qqmldebugservice_p.h>
  57
  58 #include <QtCore/qurl.h>
  59 #include <QtCore/qvariant.h>
  60 #include <QtCore/QPointer>
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 class QQmlEngine;
  65 class QQmlContext;
  66 class QQmlWatcher;
  67 class QDataStream;
  68 class QQmlDebugStatesDelegate;
  69
  70 class Q_QML_PRIVATE_EXPORT QQmlEngineDebugService : public QQmlDebugService
  71 {
  72     Q_OBJECT
  73 public:
  74     QQmlEngineDebugService(QObject * = 0);
  75     ~QQmlEngineDebugService();
  76
  77     struct QQmlObjectData {
  78         QUrl url;
  79         int lineNumber;
  80         int columnNumber;
  81         QString idString;
  82         QString objectName;
  83         QString objectType;
  84         int objectId;
  85         int contextId;
  86         int parentId;
  87     };
  88
  89     struct QQmlObjectProperty {
  90         enum Type { Unknown, Basic, Object, List, SignalProperty, Variant };
  91         Type type;
  92         QString name;
  93         QVariant value;
  94         QString valueTypeName;
  95         QString binding;
  96         bool hasNotifySignal;
  97     };
  98
  99     void addEngine(QQmlEngine *);
 100     void remEngine(QQmlEngine *);
 101     void objectCreated(QQmlEngine *, QObject *);
 102
 103     void setStatesDelegate(QQmlDebugStatesDelegate *);
 104
 105     static QQmlEngineDebugService *instance();
 106
 107 protected:
 108     virtual void messageReceived(const QByteArray &);
 109
 110 private Q_SLOTS:
 111     void processMessage(const QByteArray &msg);
 112     void propertyChanged(int id, int objectId, const QMetaProperty &property, const QVariant &value);
 113
 114 private:
 115     void prepareDeferredObjects(QObject *);
 116     void buildObjectList(QDataStream &, QQmlContext *,
 117                          const QList<QPointer<QObject> > &instances);
 118     void buildObjectDump(QDataStream &, QObject *, bool, bool);
 119     void buildStatesList(bool cleanList, const QList<QPointer<QObject> > &instances);
 120     QQmlObjectData objectData(QObject *);
 121     QQmlObjectProperty propertyData(QObject *, int);
 122     QVariant valueContents(const QVariant &defaultValue) const;
 123     bool setBinding(int objectId, const QString &propertyName, const QVariant &expression, bool isLiteralValue, QString filename = QString(), int line = -1, int column = 0);
 124     bool resetBinding(int objectId, const QString &propertyName);
 125     bool setMethodBody(int objectId, const QString &method, const QString &body);
 126     void storeObjectIds(QObject *co);
 127
 128     QList<QQmlEngine *> m_engines;
 129     QQmlWatcher *m_watch;
 130     QQmlDebugStatesDelegate *m_statesDelegate;
 131 };
 132 Q_QML_PRIVATE_EXPORT QDataStream &operator<<(QDataStream &, const QQmlEngineDebugService::QQmlObjectData &);
 133 Q_QML_PRIVATE_EXPORT QDataStream &operator>>(QDataStream &, QQmlEngineDebugService::QQmlObjectData &);
 134 Q_QML_PRIVATE_EXPORT QDataStream &operator<<(QDataStream &, const QQmlEngineDebugService::QQmlObjectProperty &);
 135 Q_QML_PRIVATE_EXPORT QDataStream &operator>>(QDataStream &, QQmlEngineDebugService::QQmlObjectProperty &);
 136
 137 QT_END_NAMESPACE
 138
 139 #endif // QQMLENGINEDEBUGSERVICE_P_H
 140