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
|
/*
enumrepositoryserver.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2016 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
Author: Volker Krause <volker.krause@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
#ifndef GAMMARAY_ENUMREPOSITORYSERVER_H
#define GAMMARAY_ENUMREPOSITORYSERVER_H
#include "gammaray_core_export.h"
#include "metaenum.h"
#include <common/enumrepository.h>
#include <QHash>
QT_BEGIN_NAMESPACE
class QMetaEnum;
QT_END_NAMESPACE
namespace GammaRay {
/*! Probe-side enum definition management.
* Use this to obtain enum value representations that can be safely transferred to the client.
*/
class EnumRepositoryServer : public EnumRepository
{
Q_OBJECT
public:
~EnumRepositoryServer() override;
/*! Creates an EnumValue instance for the given numeric value and QMetaEnum.
* If not yet present, the enum definition with be registered
* with the EnumRepositoryServer, so that the client has access
* to the key/value mappings of the enum if needed.
*/
static GAMMARAY_CORE_EXPORT EnumValue valueFromMetaEnum(int value, const QMetaEnum &me);
/*! Creates an EnumValue instance for a given QVariant containing a registered
* GammaRay::MetaEnum value.
*/
static GAMMARAY_CORE_EXPORT EnumValue valueFromVariant(const QVariant &value);
/*! Check if the given meta type id is a known enum. */
static GAMMARAY_CORE_EXPORT bool isEnum(int metaTypeId);
//! @cond internal
static GAMMARAY_CORE_EXPORT EnumRepository *create(QObject *parent); // only exported for unit tests
template<typename Enum, typename V, std::size_t N>
static void registerEnum(const MetaEnum::Value<V> (&lookup_table)[N], const char *name, bool flag)
{
if (isEnum(qMetaTypeId<Enum>()))
return;
QVector<EnumDefinitionElement> elements;
elements.reserve(N);
for (std::size_t i = 0; i < N; ++i)
elements.push_back(EnumDefinitionElement(lookup_table[i].value, lookup_table[i].name));
registerEnum(qMetaTypeId<Enum>(), name, elements, flag);
}
static GAMMARAY_CORE_EXPORT void registerEnum(int metaTypeId, const char *name, const QVector<EnumDefinitionElement> &elems, bool flag);
static inline EnumDefinition definitionForId(EnumId id)
{
return s_instance->definition(id);
}
//! @endcond
private:
explicit EnumRepositoryServer(QObject *parent = nullptr);
void requestDefinition(EnumId id) override;
EnumId m_nextId;
static EnumRepositoryServer *s_instance;
QHash<QByteArray, EnumId> m_nameToIdMap;
QHash<int, EnumId> m_typeIdToIdMap;
};
}
/*! Register a MetaEnum lookup table with the EnumRepository. */
#define ER_REGISTER_ENUM(Class, Name, LookupTable) \
{ \
EnumRepositoryServer::registerEnum<Class::Name>(LookupTable, #Class "::" #Name, false); \
}
/*! Register a MetaEnum lookup table with the EnumRepository. */
#define ER_REGISTER_FLAGS(Class, Name, LookupTable) \
{ \
EnumRepositoryServer::registerEnum<Class::Name>(LookupTable, #Class "::" #Name, true); \
}
#endif // GAMMARAY_ENUMREPOSITORYSERVER_H
|