serializable.h

/* Copyright (c) 2016-2017, Human Brain Project
 *                          Stefan.Eilemann@epfl.ch
 *
 * This file is part of Servus <https://github.com/HBPVIS/Servus>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library 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 library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef SERVUS_SERIALIZABLE_H
#define SERVUS_SERIALIZABLE_H

#include <servus/api.h>
#include <servus/types.h>

#include <functional> // function
#include <memory>     // shared_ptr

namespace servus
{
class Serializable
{
public:
    SERVUS_API Serializable();
    SERVUS_API virtual ~Serializable();

    struct Data
    {
        Data()
            : size(0)
        {
        }

        SERVUS_API Data clone();

        std::shared_ptr<const void> ptr; 
        size_t size; 
    };

    virtual std::string getTypeName() const = 0;

    SERVUS_API virtual uint128_t getTypeIdentifier() const;

    virtual std::string getSchema() const { return std::string(); }
    SERVUS_API bool fromBinary(const Data& data);
    SERVUS_API bool fromBinary(const void* data, const size_t size);

    SERVUS_API Data toBinary() const;

    SERVUS_API bool fromJSON(const std::string& json);

    SERVUS_API std::string toJSON() const;

    typedef std::function<void()> DeserializedCallback;
    typedef std::function<void()> SerializeCallback;

    SERVUS_API void registerDeserializedCallback(const DeserializedCallback&);

    SERVUS_API void registerSerializeCallback(const SerializeCallback&);

protected:
    SERVUS_API Serializable(const Serializable&);
    SERVUS_API Serializable& operator=(const Serializable&);
    SERVUS_API Serializable(Serializable&&);
    SERVUS_API Serializable& operator=(Serializable&&);

private:
    virtual bool _fromBinary(const void* /*data*/, const size_t /*size*/)
    {
        throw std::runtime_error("Binary deserialization not implemented");
    }
    virtual Data _toBinary() const
    {
        throw std::runtime_error("Binary serialization not implemented");
    }

    virtual bool _fromJSON(const std::string& /*json*/)
    {
        throw std::runtime_error("JSON deserialization not implemented");
    }
    virtual std::string _toJSON() const
    {
        throw std::runtime_error("JSON serialization not implemented");
    }

    class Impl;
    Impl* _impl;
};
}

#endif // SERVUS_SERIALIZABLE_H