serializable.h

/* Copyright (c) 2009-2016, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This file is part of Collage <https://github.com/Eyescale/Collage>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 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 CO_SERIALIZABLE_H
#define CO_SERIALIZABLE_H

#include <co/object.h> // base class

namespace co
{
namespace detail
{
class Serializable;
}

class Serializable : public Object
{
public:
    CO_API uint64_t getDirty() const;

    CO_API bool isDirty() const override;

    CO_API virtual bool isDirty(const uint64_t dirtyBits) const;

    CO_API uint128_t
        commit(const uint32_t incarnation = CO_COMMIT_NEXT) override;

protected:
    CO_API Serializable();

    CO_API Serializable(const Serializable&);

    CO_API virtual ~Serializable();

    Serializable& operator=(const Serializable& from)
    {
        Object::operator=(from);
        return *this;
    }

    virtual void serialize(co::DataOStream&, const uint64_t) = 0;

    virtual void deserialize(co::DataIStream&, const uint64_t) = 0;

    enum DirtyBits
    {
        DIRTY_NONE = 0,
        DIRTY_CUSTOM = 1,
        DIRTY_ALL = 0xFFFFFFFFFFFFFFFFull
    };

    CO_API virtual void setDirty(const uint64_t bits);

    CO_API virtual void unsetDirty(const uint64_t bits);

    ChangeType getChangeType() const override { return DELTA; }
    CO_API void notifyAttached() override;

    void getInstanceData(co::DataOStream& os) override
    {
        serialize(os, DIRTY_ALL);
    }

    CO_API void applyInstanceData(co::DataIStream& is) override;

    CO_API void pack(co::DataOStream& os) final;
    CO_API void unpack(co::DataIStream& is) final;

private:
    detail::Serializable* const _impl;
    friend class detail::Serializable;
};
}
#endif // CO_SERIALIZABLE_H