qabstractprotobufserializer.h

/*
 * MIT License
 *
 * Copyright (c) 2019 Alexey Edelev <semlanik@gmail.com>
 *
 * This file is part of QtProtobuf project https://git.semlanik.org/semlanik/qtprotobuf
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this
 * software and associated documentation files (the "Software"), to deal in the Software
 * without restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and
 * to permit persons to whom the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
 * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
 
#pragma once //QAbstractProtobufSerializer
 
#include <QObject>
#include <QVariant>
#include <QMetaObject>
 
#include <unordered_map>
#include <functional>
#include <memory>
 
#include "qtprotobuftypes.h"
#include "qtprotobuflogging.h"
#include "qprotobufselfcheckiterator.h"
 
#include "qtprotobufglobal.h"
 
namespace QtProtobuf {
 
class QProtobufMetaProperty;
class QProtobufMetaObject;
 
class Q_PROTOBUF_EXPORT QAbstractProtobufSerializer
{
public:
    template<typename T>
    QByteArray serialize(const QObject *object) {
        Q_ASSERT(object != nullptr);
        qProtoDebug() << T::staticMetaObject.className() << "serialize";
        return serializeMessage(object, T::protobufMetaObject);
    }
 
    template<typename T>
    void deserialize(T *object, const QByteArray &data) {
        Q_ASSERT(object != nullptr);
        qProtoDebug() << T::staticMetaObject.className() << "deserialize";
        //Initialize default object first and make copy aferwards, it's necessary to set default
        //values of properties that was not stored in data.
        T newValue;
        try {
            deserializeMessage(&newValue, T::protobufMetaObject, data);
        } catch(...) {
            *object = newValue;
            throw;
        }
        *object = newValue;
    }
 
    virtual ~QAbstractProtobufSerializer() = default;
 
    virtual QByteArray serializeMessage(const QObject *object, const QProtobufMetaObject &metaObject) const = 0;
 
    virtual void deserializeMessage(QObject *object, const QProtobufMetaObject &metaObject, const QByteArray &data) const = 0;
 
    virtual QByteArray serializeObject(const QObject *object, const QProtobufMetaObject &metaObject, const QProtobufMetaProperty &metaProperty) const = 0;
 
    virtual void deserializeObject(QObject *object, const QProtobufMetaObject &metaObject, QProtobufSelfcheckIterator &it) const = 0;
 
    virtual QByteArray serializeListBegin(const QProtobufMetaProperty &metaProperty) const {
        Q_UNUSED(metaProperty);
        return {};
    }
 
    virtual QByteArray serializeListObject(const QObject *object, const QProtobufMetaObject &metaObject, const QProtobufMetaProperty &metaProperty) const = 0;
 
    virtual QByteArray serializeListEnd(QByteArray &buffer, const QProtobufMetaProperty &metaProperty) const {
        Q_UNUSED(metaProperty);
        Q_UNUSED(buffer);
        return {};
    }
 
    virtual bool deserializeListObject(QObject *object, const QProtobufMetaObject &metaObject, QProtobufSelfcheckIterator &it) const = 0;
 
    virtual QByteArray serializeMapBegin(const QProtobufMetaProperty &metaProperty) const {
        Q_UNUSED(metaProperty);
        return {};
    }
 
    virtual QByteArray serializeMapPair(const QVariant &key, const QVariant &value, const QProtobufMetaProperty &metaProperty) const = 0;
 
    virtual QByteArray serializeMapEnd(QByteArray &buffer, const QProtobufMetaProperty &metaProperty) const {
        Q_UNUSED(metaProperty);
        return {};
    }
 
    virtual bool deserializeMapPair(QVariant &key, QVariant &value, QProtobufSelfcheckIterator &it) const = 0;
 
    virtual QByteArray serializeEnum(int64 value, const QMetaEnum &metaEnum, const QtProtobuf::QProtobufMetaProperty &metaProperty) const = 0;
 
    virtual QByteArray serializeEnumList(const QList<int64> &value, const QMetaEnum &metaEnum, const QtProtobuf::QProtobufMetaProperty &metaProperty) const = 0;
 
    virtual void deserializeEnum(int64 &value, const QMetaEnum &metaEnum, QProtobufSelfcheckIterator &it) const = 0;
 
    virtual void deserializeEnumList(QList<int64> &value, const QMetaEnum &metaEnum, QProtobufSelfcheckIterator &it) const = 0;
};
}
 
#include "qabstractprotobufserializer_p.h"
 
template<typename T>
static void qRegisterProtobufType() {
    T::registerTypes();
    QtProtobufPrivate::registerHandler(qMetaTypeId<T *>(), { QtProtobufPrivate::serializeObject<T>,
            QtProtobufPrivate::deserializeObject<T>, QtProtobufPrivate::ObjectHandler });
    QtProtobufPrivate::registerHandler(qMetaTypeId<QList<QSharedPointer<T>>>(), { QtProtobufPrivate::serializeList<T>,
            QtProtobufPrivate::deserializeList<T>, QtProtobufPrivate::ListHandler });
}
 
template<typename K, typename V,
         typename std::enable_if_t<!std::is_base_of<QObject, V>::value, int> = 0>
inline void qRegisterProtobufMapType() {
    QtProtobufPrivate::registerHandler(qMetaTypeId<QMap<K, V>>(), { QtProtobufPrivate::serializeMap<K, V>,
    QtProtobufPrivate::deserializeMap<K, V>, QtProtobufPrivate::MapHandler });
}
 
template<typename K, typename V,
         typename std::enable_if_t<std::is_base_of<QObject, V>::value, int> = 0>
inline void qRegisterProtobufMapType() {
    QtProtobufPrivate::registerHandler(qMetaTypeId<QMap<K, QSharedPointer<V>>>(), { QtProtobufPrivate::serializeMap<K, V>,
    QtProtobufPrivate::deserializeMap<K, V>, QtProtobufPrivate::MapHandler });
}
 
 
template<typename T,
         typename std::enable_if_t<std::is_enum<T>::value, int> = 0>
inline void qRegisterProtobufEnumType() {
    QtProtobufPrivate::registerHandler(qMetaTypeId<T>(), { QtProtobufPrivate::serializeEnum<T>,
                                                           QtProtobufPrivate::deserializeEnum<T>, QtProtobufPrivate::ObjectHandler });
    QtProtobufPrivate::registerHandler(qMetaTypeId<QList<T>>(), { QtProtobufPrivate::serializeEnumList<T>,
                                                           QtProtobufPrivate::deserializeEnumList<T>, QtProtobufPrivate::ListHandler });
}