/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright 2013 - 2020, nymea GmbH * Contact: contact@nymea.io * * This file is part of nymea. * This project including source code and documentation is protected by * copyright law, and remains the property of nymea GmbH. All rights, including * reproduction, publication, editing and translation, are reserved. The use of * this project is subject to the terms of a license agreement to be concluded * with nymea GmbH in accordance with the terms of use of nymea GmbH, available * under https://nymea.io/license * * GNU Lesser General Public License Usage * Alternatively, this project may be redistributed and/or modified under the * terms of the GNU Lesser General Public License as published by the Free * Software Foundation; version 3. This project is distributed in the hope that * it will be useful, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this project. If not, see . * * For any further details and any questions please contact us under * contact@nymea.io or see our FAQ/Licensing Information on * https://nymea.io/license/faq * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ #ifndef JSONHANDLER_H #define JSONHANDLER_H #include #include #include #include #include #include #include "jsonreply.h" #include "jsoncontext.h" class JsonHandler : public QObject { Q_OBJECT public: enum BasicType { Uuid, String, StringList, Int, Uint, Double, Bool, Variant, Color, Time, Object }; Q_ENUM(BasicType) explicit JsonHandler(QObject *parent = nullptr); virtual ~JsonHandler() = default; virtual QString name() const = 0; virtual QVariantMap translateNotification(const QString ¬ification, const QVariantMap ¶ms, const QLocale &locale); QVariantMap jsonEnums() const; QVariantMap jsonFlags() const; QVariantMap jsonObjects() const; QVariantMap jsonMethods() const; QVariantMap jsonNotifications() const; template static QString enumRef(); template static QString objectRef(); static QString objectRef(const QString &objectName); template static QString enumValueName(T value); template static T enumNameToValue(const QString &name); static BasicType variantTypeToBasicType(QVariant::Type variantType); static QVariant::Type basicTypeToVariantType(BasicType basicType); template QVariant pack(const T &value) const; template QVariant pack(T *value) const; template T unpack(const QVariant &value) const; protected: template void registerEnum(); template void registerEnum(); template void registerObject(); template void registerObject(); template void registerUncreatableObject(); template void registerUncreatableObject(); template void registerList(BasicTypeName typeName); // Deprecated QString based registerObject void registerObject(const QString &name, const QVariantMap &object); void registerMethod(const QString &name, const QString &description, const QVariantMap ¶ms, const QVariantMap &returns, const QString &deprecationInfo = QString()); void registerNotification(const QString &name, const QString &description, const QVariantMap ¶ms, const QString &deprecationInfo = QString()); JsonReply *createReply(const QVariantMap &data) const; JsonReply *createAsyncReply(const QString &method) const; private: void registerObject(const QMetaObject &metaObject); void registerObject(const QMetaObject &metaObject, const QMetaObject &listMetaObject); QVariant pack(const QMetaObject &metaObject, const void *gadget) const; QVariant unpack(const QMetaObject &metaObject, const QVariant &value) const; private: QVariantMap m_enums; QHash m_metaEnums; QVariantMap m_flags; QHash m_metaFlags; QHash m_flagsEnums; QVariantMap m_objects; QHash m_metaObjects; QHash m_listMetaObjects; QHash m_listEntryTypes; QVariantMap m_methods; QVariantMap m_notifications; }; Q_DECLARE_METATYPE(QVariant::Type) template void JsonHandler::registerEnum() { QMetaEnum metaEnum = QMetaEnum::fromType(); QStringList values; for (int i = 0; i < metaEnum.keyCount(); i++) { values << metaEnum.key(i); } m_enums.insert(metaEnum.name(), values); m_metaEnums.insert(metaEnum.name(), metaEnum); } template void JsonHandler::registerEnum() { registerEnum(); QMetaEnum metaEnum = QMetaEnum::fromType(); QMetaEnum metaFlags = QMetaEnum::fromType(); m_metaFlags.insert(metaFlags.name(), metaFlags); m_flagsEnums.insert(metaFlags.name(), metaEnum.name()); m_flags.insert(metaFlags.name(), QVariantList() << QString("$ref:%1").arg(metaEnum.name())); } template void JsonHandler::registerObject() { qRegisterMetaType(); QMetaObject metaObject = ObjectType::staticMetaObject; registerObject(metaObject); } template void JsonHandler::registerObject() { qRegisterMetaType(); qRegisterMetaType(); QMetaObject metaObject = ObjectType::staticMetaObject; QMetaObject listMetaObject = ListType::staticMetaObject; registerObject(metaObject, listMetaObject); } template void JsonHandler::registerUncreatableObject() { QMetaObject metaObject = ObjectType::staticMetaObject; registerObject(metaObject); } template void JsonHandler::registerUncreatableObject() { QMetaObject metaObject = ObjectType::staticMetaObject; QMetaObject listMetaObject = ListType::staticMetaObject; registerObject(metaObject, listMetaObject); } template void JsonHandler::registerList(BasicTypeName typeName) { QMetaObject listMetaObject = ListType::staticMetaObject; QString listTypeName = QString(listMetaObject.className()).split("::").last(); m_metaObjects.insert(listTypeName, listMetaObject); m_objects.insert(listTypeName, QVariantList() << QVariant(QString("$ref:%1").arg(enumValueName(typeName)))); Q_ASSERT_X(listMetaObject.indexOfProperty("count") >= 0, "JsonHandler", QString("List type %1 does not implement \"count\" property!").arg(listTypeName).toUtf8()); Q_ASSERT_X(listMetaObject.indexOfMethod("get(int)") >= 0, "JsonHandler", QString("List type %1 does not implement \"Q_INVOKABLE QVariant get(int index)\" method!").arg(listTypeName).toUtf8()); Q_ASSERT_X(listMetaObject.indexOfMethod("put(QVariant)") >= 0, "JsonHandler", QString("List type %1 does not implement \"Q_INVOKABLE void put(QVariant variant)\" method!").arg(listTypeName).toUtf8()); } template QString JsonHandler::enumRef() { QMetaEnum metaEnum = QMetaEnum::fromType(); return QString("$ref:%1").arg(metaEnum.name()); } template QString JsonHandler::objectRef() { QMetaObject metaObject = T::staticMetaObject; return QString("$ref:%1").arg(QString(metaObject.className()).split("::").last()); } template QString JsonHandler::enumValueName(T value) { QMetaEnum metaEnum = QMetaEnum::fromType(); return metaEnum.valueToKey(value); } template T JsonHandler::enumNameToValue(const QString &name) { QMetaEnum metaEnum = QMetaEnum::fromType(); return static_cast(metaEnum.keyToValue(name.toUtf8())); } template QVariant JsonHandler::pack(const T &value) const { QMetaObject metaObject = T::staticMetaObject; return pack(metaObject, static_cast(&value)); } template QVariant JsonHandler::pack(T *value) const { QMetaObject metaObject = T::staticMetaObject; return pack(metaObject, static_cast(value)); } template T JsonHandler::unpack(const QVariant &value) const { QMetaObject metaObject = T::staticMetaObject; QVariant ret = unpack(metaObject, value); return ret.value(); } #endif // JSONHANDLER_H