aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/qml/qqmlmetaobject_p.h
blob: 498c27884ec67a4413935d7b0380aa6391a6e0c8 (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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QQMLMETAOBJECT_P_H
#define QQMLMETAOBJECT_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <private/qqmlpropertycache_p.h>

#include <QtQml/qtqmlglobal.h>
#include <QtCore/qvarlengtharray.h>
#include <QtCore/qmetaobject.h>

QT_BEGIN_NAMESPACE

// QQmlMetaObject serves as a wrapper around either QMetaObject or QQmlPropertyCache.
// This is necessary as we delay creation of QMetaObject for synthesized QObjects, but
// we don't want to needlessly generate QQmlPropertyCaches every time we encounter a
// QObject type used in assignment or when we don't have a QQmlEngine etc.
//
// This class does NOT reference the propertycache.
class QQmlEnginePrivate;
class QQmlPropertyData;
class Q_QML_EXPORT QQmlMetaObject
{
public:
    template<qsizetype Prealloc>
    using ArgTypeStorage = QVarLengthArray<QMetaType, Prealloc>;

    inline QQmlMetaObject() = default;
    inline QQmlMetaObject(const QObject *);
    inline QQmlMetaObject(const QMetaObject *);
    inline QQmlMetaObject(const QQmlPropertyCache::ConstPtr &);
    inline QQmlMetaObject(const QQmlMetaObject &);

    inline QQmlMetaObject &operator=(const QQmlMetaObject &);

    inline bool isNull() const;

    inline const char *className() const;
    inline int propertyCount() const;

    inline const QMetaObject *metaObject() const;

    QMetaType methodReturnType(const QQmlPropertyData &data, QByteArray *unknownTypeError) const;

    /*!
      \internal
      Returns false if one of the types is unknown. Otherwise, fills \a argstorage with the
      metatypes of the function.
    */
    template<typename ArgTypeStorage>
    bool methodParameterTypes(
            int index, ArgTypeStorage *argStorage, QByteArray *unknownTypeError) const
    {
        Q_ASSERT(_m && index >= 0);

        QMetaMethod m = _m->method(index);
        return methodParameterTypes(m, argStorage, unknownTypeError);
    }

    /*!
      \internal
      Returns false if one of the types is unknown. Otherwise, fills \a argstorage with the
      metatypes of the function.
    */
    template<typename ArgTypeStorage>
    bool constructorParameterTypes(
            int index, ArgTypeStorage *dummy, QByteArray *unknownTypeError) const
    {
        QMetaMethod m = _m->constructor(index);
        return methodParameterTypes(m, dummy, unknownTypeError);
    }


    static bool canConvert(const QQmlMetaObject &from, const QQmlMetaObject &to)
    {
        Q_ASSERT(!from.isNull() && !to.isNull());
        return from.metaObject()->inherits(to.metaObject());
    }

    // static_metacall (on Gadgets) doesn't call the base implementation and therefore
    // we need a helper to find the correct meta object and property/method index.
    static void resolveGadgetMethodOrPropertyIndex(
            QMetaObject::Call type, const QMetaObject **metaObject, int *index);

    template<typename ArgTypeStorage>
    static bool methodParameterTypes(
            const QMetaMethod &method, ArgTypeStorage *argStorage, QByteArray *unknownTypeError)
    {
        Q_ASSERT(argStorage);

        const int argc = method.parameterCount();
        argStorage->resize(argc);
        for (int ii = 0; ii < argc; ++ii) {
            if (!parameterType(method, ii, unknownTypeError, [argStorage](int ii, QMetaType &&type) {
                    argStorage->operator[](ii) = std::forward<QMetaType>(type);
                })) {
                return false;
            }
        }
        return true;
    }

    template<typename ArgTypeStorage>
    static bool methodReturnAndParameterTypes(
            const QMetaMethod &method, ArgTypeStorage *argStorage, QByteArray *unknownTypeError)
    {
        Q_ASSERT(argStorage);

        const int argc = method.parameterCount();
        argStorage->resize(argc + 1);

        QMetaType type = method.returnMetaType();
        if (type.flags().testFlag(QMetaType::IsEnumeration))
            type = type.underlyingType();

        if (!type.isValid()) {
            if (unknownTypeError)
                *unknownTypeError = "return type";
            return false;
        }

        argStorage->operator[](0) = type;

        for (int ii = 0; ii < argc; ++ii) {
            if (!parameterType(
                        method, ii, unknownTypeError, [argStorage](int ii, QMetaType &&type) {
                    argStorage->operator[](ii + 1) = std::forward<QMetaType>(type);
                })) {
                return false;
            }
        }

        return true;
    }

protected:
    template<typename Store>
    static bool parameterType(
            const QMetaMethod &method, int ii, QByteArray *unknownTypeError, const Store &store)
    {
        QMetaType type = method.parameterMetaType(ii);

               // we treat enumerations as their underlying type
        if (type.flags().testFlag(QMetaType::IsEnumeration))
            type = type.underlyingType();

        if (!type.isValid()) {
            if (unknownTypeError)
                *unknownTypeError =  method.parameterTypeName(ii);
            return false;
        }

        store(ii, std::move(type));
        return true;
    }


    const QMetaObject *_m = nullptr;

};

QQmlMetaObject::QQmlMetaObject(const QObject *o)
{
    if (o)
        _m = o->metaObject();
}

QQmlMetaObject::QQmlMetaObject(const QMetaObject *m)
    : _m(m)
{
}

QQmlMetaObject::QQmlMetaObject(const QQmlPropertyCache::ConstPtr &m)
{
    if (m)
        _m = m->createMetaObject();
}

QQmlMetaObject::QQmlMetaObject(const QQmlMetaObject &o)
    : _m(o._m)
{
}

QQmlMetaObject &QQmlMetaObject::operator=(const QQmlMetaObject &o)
{
    _m = o._m;
    return *this;
}

bool QQmlMetaObject::isNull() const
{
    return !_m;
}

const char *QQmlMetaObject::className() const
{
    if (!_m)
        return nullptr;
    return metaObject()->className();
}

int QQmlMetaObject::propertyCount() const
{
    if (!_m)
        return 0;
    return metaObject()->propertyCount();
}

const QMetaObject *QQmlMetaObject::metaObject() const
{
    return _m;
}

QT_END_NAMESPACE

#endif // QQMLMETAOBJECT_P_H