serializable.h

/* Copyright (c) 2009-2011, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * 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
#include <co/dataOStream.h>   // used inline
#include <co/dataIStream.h>   // used inline

namespace co
{
    class Serializable : public Object
    {
    public:
        uint64_t getDirty() const { return _dirty; }

        virtual bool isDirty() const { return ( _dirty != DIRTY_NONE ); }

        virtual bool isDirty( const uint64_t dirtyBits ) const
            { return (_dirty & dirtyBits) == dirtyBits; }

        virtual uint128_t commit( const uint32_t incarnation = CO_COMMIT_NEXT )
            {
                const uint128_t& version = co::Object::commit( incarnation );
                _dirty = DIRTY_NONE;
                return version;
            }

    protected:
        Serializable() : _dirty( DIRTY_NONE ) {}
        
        Serializable( const Serializable& )
                : co::Object(), _dirty ( DIRTY_NONE ) {}
        
        virtual ~Serializable() {}

        virtual void serialize( co::DataOStream&, const uint64_t ){};

        virtual void deserialize( co::DataIStream&, const uint64_t ){};

        virtual ChangeType getChangeType() const { return DELTA; }

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

        virtual void setDirty( const uint64_t bits ) { _dirty |= bits; }

        virtual void unsetDirty( const uint64_t bits ) { _dirty &= ~bits; }

        virtual void notifyAttached()
            {
                if( isMaster( ))
                    _dirty = DIRTY_NONE;
            }

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

        virtual void applyInstanceData( co::DataIStream& is )
            {
                if( !is.hasData( ))
                    return;
                deserialize( is, DIRTY_ALL );
            }

        virtual void pack( co::DataOStream& os )
            {
                if( _dirty == DIRTY_NONE )
                    return;

                os << _dirty;
                serialize( os, _dirty );
            }

        virtual void unpack( co::DataIStream& is )
            {
                EQASSERT( is.hasData( ));
                if( !is.hasData( ))
                    return;

                uint64_t dirty;
                is >> dirty;
                deserialize( is, dirty );
            }

        uint64_t _dirty;

        struct Private;
        Private* _private; // placeholder for binary-compatible changes
    };
}
#endif // CO_SERIALIZABLE_H