summaryrefslogtreecommitdiff
path: root/src/qtmetaobjectpublisher.cpp
blob: 6d67df1e55ed774d5ed1235411126db181d06881 (plain)
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Copyright (C) 2013 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QWebChannel module on Qt labs.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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.
**
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qtmetaobjectpublisher.h"

#include <QStringList>
#include <QMetaObject>
#include <QMetaProperty>

static const QString KEY_SIGNALS = QStringLiteral("signals");
static const QString KEY_METHODS = QStringLiteral("methods");
static const QString KEY_PROPERTIES = QStringLiteral("properties");
static const QString KEY_ENUMS = QStringLiteral("enums");

static const QString KEY_QOBJECT = QStringLiteral("__QObject*__");
static const QString KEY_ID = QStringLiteral("id");
static const QString KEY_DATA = QStringLiteral("data");

QtMetaObjectPublisher::QtMetaObjectPublisher(QQuickItem *parent)
    : QQuickItem(parent)
{
}

QVariantMap QtMetaObjectPublisher::classInfoForObjects(const QVariantMap &objectMap) const
{
    QVariantMap ret;
    QMap<QString, QVariant>::const_iterator it = objectMap.constBegin();
    while (it != objectMap.constEnd()) {
        QObject* object = it.value().value<QObject*>();
        if (object) {
            const QVariantMap &info = classInfoForObject(object);
            if (!info.isEmpty()) {
                ret[it.key()] = info;
            }
        }
        ++it;
    }
    return ret;
}

QVariantMap QtMetaObjectPublisher::classInfoForObject(QObject *object) const
{
    QVariantMap data;
    if (!object) {
        qWarning("null object given to MetaObjectPublisher - bad API usage?");
        return data;
    }
    QVariantList qtSignals, qtMethods;
    QVariantList qtProperties;
    QVariantMap qtEnums;
    const QMetaObject* metaObject = object->metaObject();
    QSet<int> notifySignals;
    QSet<QString> properties;
    for (int i = 0; i < metaObject->propertyCount(); ++i) {
        const QMetaProperty &prop = metaObject->property(i);
        QVariantList propertyInfo;
        const QString &propertyName = QString::fromLatin1(prop.name());
        propertyInfo.append(propertyName);
        properties << propertyName;
        if (prop.hasNotifySignal()) {
            notifySignals << prop.notifySignalIndex();
            const int numParams = prop.notifySignal().parameterCount();
            if (numParams > 1) {
                qWarning("Notify signal for property '%s' has %d parameters, expected zero or one.",
                         prop.name(), numParams);
            }
            propertyInfo.append(QString::fromLatin1(prop.notifySignal().name()));
        } else {
            if (!prop.isConstant()) {
                qWarning("Property '%s'' of object '%s' has no notify signal and is not constant, "
                         "value updates in HTML will be broken!",
                         prop.name(), object->metaObject()->className());
            }
            propertyInfo.append(QString());
        }
        propertyInfo.append(prop.read(object));
        qtProperties.append(QVariant::fromValue(propertyInfo));
    }
    for (int i = 0; i < metaObject->methodCount(); ++i) {
        if (notifySignals.contains(i)) {
            continue;
        }
        const QMetaMethod &method = metaObject->method(i);
        //NOTE: This will not work for overloaded methods/signals.
        //NOTE: this must be a string, otherwise it will be converted to '{}' in QML
        const QString &name = QString::fromLatin1(method.name());
        if (properties.contains(name)) {
            // optimize: Don't send the getter method, it gets overwritten by the
            // property on the client side anyways.
            continue;
        }
        if (method.access() == QMetaMethod::Public)
            qtMethods << name;
        if (method.methodType() == QMetaMethod::Signal)
            qtSignals << name;
    }
    for (int i = 0; i < metaObject->enumeratorCount(); ++i) {
        QMetaEnum enumerator = metaObject->enumerator(i);
        QVariantMap values;
        for (int k = 0; k < enumerator.keyCount(); ++k) {
            values[enumerator.key(k)] = enumerator.value(k);
        }
        qtEnums[enumerator.name()] = values;
    }
    data[KEY_SIGNALS] = qtSignals;
    data[KEY_METHODS] = qtMethods;
    data[KEY_PROPERTIES] = QVariant::fromValue(qtProperties);
    data[KEY_ENUMS] = qtEnums;
    return data;
}

static QString objectId(QObject *object)
{
    return QString::number(quintptr(object), 16);
}

QVariant QtMetaObjectPublisher::wrapObject(QObject *object)
{
    if (!object)
        return QVariant();

    const QString& id = objectId(object);

    const WrapMapCIt& p = m_wrappedObjects.constFind(id);
    if (p != m_wrappedObjects.constEnd())
        return p.value().second;

    QVariantMap objectInfo;
    objectInfo[KEY_QOBJECT] = true;
    objectInfo[KEY_ID] = id;
    objectInfo[KEY_DATA] = classInfoForObject(object);

    m_wrappedObjects.insert(id, WrapInfo(object, objectInfo));
    connect(object, SIGNAL(destroyed(QObject*)), SLOT(wrappedObjectDestroyed(QObject*)));

    return objectInfo;
}

QObject *QtMetaObjectPublisher::unwrapObject(const QString& id) const
{
    const WrapMapCIt& p = m_wrappedObjects.constFind(id);
    if (p != m_wrappedObjects.constEnd())
        return p.value().first;
    return 0;
}

void QtMetaObjectPublisher::wrappedObjectDestroyed(QObject* object)
{
    const QString& id = objectId(object);
    m_wrappedObjects.remove(id);
    emit wrappedObjectDestroyed(id);
}

void QtMetaObjectPublisher::deleteWrappedObject(QObject* object) const
{
    if (!m_wrappedObjects.contains(objectId(object))) {
        qWarning() << "Not deleting non-wrapped object" << object;
        return;
    }
    object->deleteLater();
}