qqmlmetaobject_p.h

Go to the documentation of this file.

// 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, QString *unknownTypeError = nullptr) 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(
            const QQmlPropertyData &data, ArgTypeStorage *argStorage,
            QString *unknownTypeError = nullptr) const
    {
        Q_ASSERT(_m && data.coreIndex() >= 0);
 
        QMetaMethod m = _m->method(data.coreIndex());
        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 methodReturnAndParameterTypes(
            const QQmlPropertyData &data, ArgTypeStorage *argStorage,
            QString *unknownTypeError = nullptr) const
    {
        Q_ASSERT(_m && data.coreIndex() >= 0);
 
        QMetaMethod m = _m->method(data.coreIndex());
        return methodReturnAndParameterTypes(data, 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(
            const QQmlPropertyData &data, ArgTypeStorage *argStorarge,
            QString *unknownTypeError = nullptr) const
    {
        Q_ASSERT(_m && data.coreIndex() >= 0);
 
        QMetaMethod m = _m->constructor(data.coreIndex());
        return methodParameterTypes(m, argStorarge, 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 constructorReturnAndParameterTypes(
            const QQmlPropertyData &data, ArgTypeStorage *storage,
            QString *unknownTypeError = nullptr) const
    {
        Q_ASSERT(_m && data.coreIndex() >= 0);
 
        QMetaMethod m = _m->constructor(data.coreIndex());
        return methodReturnAndParameterTypes(data, m, storage, 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,
            QString *unknownTypeError = nullptr)
    {
        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>
    bool methodReturnAndParameterTypes(
            const QQmlPropertyData &data, const QMetaMethod &method, ArgTypeStorage *argStorage,
            QString *unknownTypeError = nullptr) const
    {
        Q_ASSERT(argStorage);
 
        const int argc = method.parameterCount();
        argStorage->resize(argc + 1);
 
        QMetaType type = methodReturnType(data, unknownTypeError);
        if (!type.isValid())
            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, QString *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 = QLatin1String("Unknown method parameter type: ")
                        + QString::fromUtf8(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