path: root/src/corelib/kernel/qmetaobject.h

// Copyright (C) 2016 The Qt Company Ltd.// Copyright (C) 2014 Olivier Goffart <ogoffart@woboq.com>// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only#ifndef QMETAOBJECT_H#define QMETAOBJECT_H#include <QtCore/qobjectdefs.h>#include <QtCore/qcompare.h>#include <QtCore/qvariant.h> QT_BEGIN_NAMESPACE class QUntypedBindable;#define Q_METAMETHOD_INVOKE_MAX_ARGS 10class Q_CORE_EXPORT QMetaMethod {public:constexpr inlineQMetaMethod() :mobj(nullptr),data({nullptr}) {} QByteArray methodSignature()const; QByteArray name()const; QByteArrayView nameView()const;const char*typeName()const;intreturnType()const; QMetaType returnMetaType()const;intparameterCount()const;intparameterType(int index)const; QMetaType parameterMetaType(int index)const;voidgetParameterTypes(int*types)const; QList<QByteArray>parameterTypes()const; QByteArray parameterTypeName(int index)const; QList<QByteArray>parameterNames()const;const char*tag()const;enum Access { Private, Protected, Public }; Access access()const;enum MethodType { Method, Signal, Slot, Constructor }; MethodType methodType()const;enum Attributes { Compatibility =0x1, Cloned =0x2, Scriptable =0x4};intattributes()const;intmethodIndex()const;intrelativeMethodIndex()const;intrevision()const;boolisConst()const;inlineconst QMetaObject *enclosingMetaObject()const{return mobj; }#if QT_VERSION <= QT_VERSION_CHECK(7, 0, 0)boolinvoke(QObject *object,Qt::ConnectionType connectionType, QGenericReturnArgument returnValue, QGenericArgument val0 =QGenericArgument(nullptr), QGenericArgument val1 =QGenericArgument(), QGenericArgument val2 =QGenericArgument(), QGenericArgument val3 =QGenericArgument(), QGenericArgument val4 =QGenericArgument(), QGenericArgument val5 =QGenericArgument(), QGenericArgument val6 =QGenericArgument(), QGenericArgument val7 =QGenericArgument(), QGenericArgument val8 =QGenericArgument(), QGenericArgument val9 =QGenericArgument())const;inlineboolinvoke(QObject *object, QGenericReturnArgument returnValue, QGenericArgument val0 =QGenericArgument(nullptr), QGenericArgument val1 =QGenericArgument(), QGenericArgument val2 =QGenericArgument(), QGenericArgument val3 =QGenericArgument(), QGenericArgument val4 =QGenericArgument(), QGenericArgument val5 =QGenericArgument(), QGenericArgument val6 =QGenericArgument(), QGenericArgument val7 =QGenericArgument(), QGenericArgument val8 =QGenericArgument(), QGenericArgument val9 =QGenericArgument())const{returninvoke(object,Qt::AutoConnection, returnValue, val0, val1, val2, val3, val4, val5, val6, val7, val8, val9);}inlineboolinvoke(QObject *object,Qt::ConnectionType connectionType, QGenericArgument val0, QGenericArgument val1 =QGenericArgument(), QGenericArgument val2 =QGenericArgument(), QGenericArgument val3 =QGenericArgument(), QGenericArgument val4 =QGenericArgument(), QGenericArgument val5 =QGenericArgument(), QGenericArgument val6 =QGenericArgument(), QGenericArgument val7 =QGenericArgument(), QGenericArgument val8 =QGenericArgument(), QGenericArgument val9 =QGenericArgument())const{returninvoke(object, connectionType,QGenericReturnArgument(), val0, val1, val2, val3, val4, val5, val6, val7, val8, val9);}inlineboolinvoke(QObject *object, QGenericArgument val0, QGenericArgument val1 =QGenericArgument(), QGenericArgument val2 =QGenericArgument(), QGenericArgument val3 =QGenericArgument(), QGenericArgument val4 =QGenericArgument(), QGenericArgument val5 =QGenericArgument(), QGenericArgument val6 =QGenericArgument(), QGenericArgument val7 =QGenericArgument(), QGenericArgument val8 =QGenericArgument(), QGenericArgument val9 =QGenericArgument())const{returninvoke(object,Qt::AutoConnection,QGenericReturnArgument(), val0, val1, val2, val3, val4, val5, val6, val7, val8, val9);}boolinvokeOnGadget(void*gadget, QGenericReturnArgument returnValue, QGenericArgument val0 =QGenericArgument(nullptr), QGenericArgument val1 =QGenericArgument(), QGenericArgument val2 =QGenericArgument(), QGenericArgument val3 =QGenericArgument(), QGenericArgument val4 =QGenericArgument(), QGenericArgument val5 =QGenericArgument(), QGenericArgument val6 =QGenericArgument(), QGenericArgument val7 =QGenericArgument(), QGenericArgument val8 =QGenericArgument(), QGenericArgument val9 =QGenericArgument())const;inlineboolinvokeOnGadget(void*gadget, QGenericArgument val0, QGenericArgument val1 =QGenericArgument(), QGenericArgument val2 =QGenericArgument(), QGenericArgument val3 =QGenericArgument(), QGenericArgument val4 =QGenericArgument(), QGenericArgument val5 =QGenericArgument(), QGenericArgument val6 =QGenericArgument(), QGenericArgument val7 =QGenericArgument(), QGenericArgument val8 =QGenericArgument(), QGenericArgument val9 =QGenericArgument())const{returninvokeOnGadget(gadget,QGenericReturnArgument(), val0, val1, val2, val3, val4, val5, val6, val7, val8, val9);}#endiftemplate<typename ReturnArg, typename... Args>#ifdef Q_QDOCbool#elseQtPrivate::Invoke::IfNotOldStyleArgs<bool, Args...>#endifinvoke(QObject *obj,Qt::ConnectionType c, QTemplatedMetaMethodReturnArgument<ReturnArg> r, Args &&... arguments)const{auto h =QtPrivate::invokeMethodHelper(r,std::forward<Args>(arguments)...);returninvokeImpl(*this, obj, c, h.parameterCount(), h.parameters.data(), h.typeNames.data(), h.metaTypes.data());}template<typename... Args>#ifdef Q_QDOCbool#elseQtPrivate::Invoke::IfNotOldStyleArgs<bool, Args...>#endifinvoke(QObject *obj,Qt::ConnectionType c, Args &&... arguments)const{returninvoke(obj, c, QTemplatedMetaMethodReturnArgument<void>{},std::forward<Args>(arguments)...);}template<typename ReturnArg, typename... Args>#ifdef Q_QDOCbool#elseQtPrivate::Invoke::IfNotOldStyleArgs<bool, Args...>#endifinvoke(QObject *obj, QTemplatedMetaMethodReturnArgument<ReturnArg> r, Args &&... arguments)const{returninvoke(obj,Qt::AutoConnection, r,std::forward<Args>(arguments)...);}template<typename... Args>#ifdef Q_QDOCbool#elseQtPrivate::Invoke::IfNotOldStyleArgs<bool, Args...>#endifinvoke(QObject *obj, Args &&... arguments)const{returninvoke(obj,Qt::AutoConnection,std::forward<Args>(arguments)...);}template<typename ReturnArg, typename... Args>#ifdef Q_QDOCbool#elseQtPrivate::Invoke::IfNotOldStyleArgs<bool, Args...>#endifinvokeOnGadget(void*gadget, QTemplatedMetaMethodReturnArgument<ReturnArg> r, Args &&... arguments)const{auto h =QtPrivate::invokeMethodHelper(r,std::forward<Args>(arguments)...);returninvokeImpl(*this, gadget,Qt::ConnectionType(-1), h.parameterCount(), h.parameters.data(), h.typeNames.data(), h.metaTypes.data());}template<typename... Args>#ifdef Q_QDOCbool#elseQtPrivate::Invoke::IfNotOldStyleArgs<bool, Args...>#endifinvokeOnGadget(void*gadget, Args &&... arguments)const{returninvokeOnGadget(gadget, QTemplatedMetaMethodReturnArgument<void>{},std::forward<Args>(arguments)...);}inlineboolisValid()const{return mobj !=nullptr; }template<typename PointerToMemberFunction>staticinline QMetaMethod fromSignal(PointerToMemberFunction signal){typedef QtPrivate::FunctionPointer<PointerToMemberFunction> SignalType;static_assert(QtPrivate::HasQ_OBJECT_Macro<typename SignalType::Object>::Value,"No Q_OBJECT in the class with the signal");returnfromSignalImpl(&SignalType::Object::staticMetaObject,reinterpret_cast<void**>(&signal));}private:static boolinvokeImpl(QMetaMethod self,void*target,Qt::ConnectionType, qsizetype paramCount,const void*const*parameters,const char*const*typeNames,constQtPrivate::QMetaTypeInterface *const*metaTypes);static QMetaMethod fromSignalImpl(const QMetaObject *,void**);static QMetaMethod fromRelativeMethodIndex(const QMetaObject *mobj,int index);static QMetaMethod fromRelativeConstructorIndex(const QMetaObject *mobj,int index);protected:struct Data {enum{ Size =6}; uint name()const{return d[0]; } uint argc()const{return d[1]; } uint parameters()const{return d[2]; } uint tag()const{return d[3]; } uint flags()const{return d[4]; } uint metaTypeOffset()const{return d[5]; }booloperator==(const Data &other)const{return d == other.d; }const uint *d;};private:constexprQMetaMethod(const QMetaObject *metaObject,const Data &data_):mobj(metaObject),data(data_){}protected:const QMetaObject *mobj; Data data;friendstruct QMetaObject;friendstruct QMetaObjectPrivate;friend class QObject;private:friendboolcomparesEqual(const QMetaMethod &lhs,const QMetaMethod &rhs) noexcept {return lhs.data == rhs.data; }Q_DECLARE_EQUALITY_COMPARABLE(QMetaMethod)};Q_DECLARE_TYPEINFO(QMetaMethod, Q_RELOCATABLE_TYPE);class Q_CORE_EXPORT QMetaEnum {public:constexpr inlineQMetaEnum() :mobj(nullptr),data({nullptr}) {}const char*name()const;const char*enumName()const; QMetaType metaType()const;boolisFlag()const;boolisScoped()const;boolis64Bit()const;intkeyCount()const;const char*key(int index)const;intvalue(int index)const;std::optional<quint64>value64(int index)const;const char*scope()const;intkeyToValue(const char*key,bool*ok =nullptr)const;intkeysToValue(const char*keys,bool*ok =nullptr)const;std::optional<quint64>keyToValue64(const char*key)const;std::optional<quint64>keysToValue64(const char*keys)const;#if QT_CORE_REMOVED_SINCE(6, 9)const char*valueToKey(int value)const; QByteArray valueToKeys(int value)const;#endifconst char*valueToKey(quint64 value)const; QByteArray valueToKeys(quint64 value)const;inlineconst QMetaObject *enclosingMetaObject()const{return mobj; }inlineboolisValid()const{returnname() !=nullptr; }template<typename T>static QMetaEnum fromType(){static_assert(QtPrivate::IsQEnumHelper<T>::Value,"QMetaEnum::fromType only works with enums declared as ""Q_ENUM, Q_ENUM_NS, Q_FLAG or Q_FLAG_NS");const QMetaObject *metaObject =qt_getEnumMetaObject(T());const char*name =qt_getEnumName(T());return metaObject->enumerator(metaObject->indexOfEnumerator(name));}private:struct Data {enum{ Size =5}; quint32 name()const{return d[0]; } quint32 alias()const{return d[1]; } quint32 flags()const{return d[2]; } qint32 keyCount()const{return static_cast<qint32>(d[3]); } quint32 data()const{return d[4]; }intindex(const QMetaObject *mobj)const;const uint *d;};QMetaEnum(const QMetaObject *mobj,int index);template<typename... Args> quint64 value_helper(uint index, Args...)const noexcept;const QMetaObject *mobj; Data data;friendstruct QMetaObject;friendstruct QMetaObjectPrivate;};Q_DECLARE_TYPEINFO(QMetaEnum, Q_RELOCATABLE_TYPE);class Q_CORE_EXPORT QMetaProperty {public:constexprQMetaProperty() :mobj(nullptr),data({nullptr}) {}const char*name()const;const char*typeName()const;#if QT_DEPRECATED_SINCE(6, 0) QT_WARNING_PUSH QT_WARNING_DISABLE_DEPRECATED QT_DEPRECATED_VERSION_6_0 QVariant::Type type()const{int t =userType();return t >=QMetaType::User ?QVariant::UserType :QVariant::Type(t); } QT_WARNING_POP #endifintuserType()const{returntypeId(); }inttypeId()const{returnmetaType().id(); } QMetaType metaType()const;intpropertyIndex()const;intrelativePropertyIndex()const;boolisReadable()const;boolisWritable()const;boolisResettable()const;boolisDesignable()const;boolisScriptable()const;boolisStored()const;boolisUser()const;boolisConstant()const;boolisFinal()const;boolisRequired()const;boolisBindable()const;boolisFlagType()const;boolisEnumType()const; QMetaEnum enumerator()const;boolhasNotifySignal()const; QMetaMethod notifySignal()const;intnotifySignalIndex()const;intrevision()const; QVariant read(const QObject *obj)const;boolwrite(QObject *obj,const QVariant &value)const;boolwrite(QObject *obj, QVariant &&value)const;boolreset(QObject *obj)const; QUntypedBindable bindable(QObject *object)const; QVariant readOnGadget(const void*gadget)const;boolwriteOnGadget(void*gadget,const QVariant &value)const;boolwriteOnGadget(void*gadget, QVariant &&value)const;boolresetOnGadget(void*gadget)const;boolhasStdCppSet()const;boolisAlias()const;inlineboolisValid()const{returnisReadable(); }inlineconst QMetaObject *enclosingMetaObject()const{return mobj; }private:#if QT_DEPRECATED_SINCE(6, 4)QT_DEPRECATED_VERSION_X_6_4("obsolete, simply returns typeId()")intregisterPropertyType()const;#endifstruct Data {enum{ Size =5}; uint name()const{return d[0]; } uint type()const{return d[1]; } uint flags()const{return d[2]; } uint notifyIndex()const{return d[3]; } uint revision()const{return d[4]; }intindex(const QMetaObject *mobj)const;const uint *d;};QMetaProperty(const QMetaObject *mobj,int index);static Data getMetaPropertyData(const QMetaObject *mobj,int index);const QMetaObject *mobj; Data data; QMetaEnum menum;friendstruct QMetaObject;friendstruct QMetaObjectPrivate;};class Q_CORE_EXPORT QMetaClassInfo {public:constexpr inlineQMetaClassInfo() :mobj(nullptr),data({nullptr}) {}const char*name()const;const char*value()const;inlineconst QMetaObject *enclosingMetaObject()const{return mobj; }private:struct Data {enum{ Size =2}; uint name()const{return d[0]; } uint value()const{return d[1]; }const uint *d;};const QMetaObject *mobj; Data data;friendstruct QMetaObject;};Q_DECLARE_TYPEINFO(QMetaClassInfo, Q_RELOCATABLE_TYPE); QT_END_NAMESPACE #endif// QMETAOBJECT_H