mirror of https://github.com/stella-emu/stella.git
64 lines
1.7 KiB
C++
64 lines
1.7 KiB
C++
//============================================================================
|
|
//
|
|
// SSSS tt lll lll
|
|
// SS SS tt ll ll
|
|
// SS tttttt eeee ll ll aaaa
|
|
// SSSS tt ee ee ll ll aa
|
|
// SS tt eeeeee ll ll aaaaa -- "An Atari 2600 VCS Emulator"
|
|
// SS SS tt ee ll ll aa aa
|
|
// SSSS ttt eeeee llll llll aaaaa
|
|
//
|
|
// Copyright (c) 1995-2009 by Bradford W. Mott and the Stella team
|
|
//
|
|
// See the file "license" for information on usage and redistribution of
|
|
// this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
//
|
|
// $Id$
|
|
//============================================================================
|
|
|
|
#ifndef SERIALIZABLE_HXX
|
|
#define SERIALIZABLE_HXX
|
|
|
|
#include "Serializer.hxx"
|
|
#include "Deserializer.hxx"
|
|
|
|
/**
|
|
This class provides an interface for (de)serializing objects.
|
|
It exists strictly to guarantee that all required classes use
|
|
method signatures as defined below.
|
|
|
|
@author Stephen Anthony
|
|
@version $Id$
|
|
*/
|
|
class Serializable
|
|
{
|
|
public:
|
|
Serializable() { }
|
|
virtual ~Serializable() { }
|
|
|
|
/**
|
|
Save the current state of the object to the given Serializer.
|
|
|
|
@param out The Serializer object to use
|
|
@return False on any errors, else true
|
|
*/
|
|
virtual bool save(Serializer& out) const = 0;
|
|
|
|
/**
|
|
Load the current state of the object from the given Deserializer.
|
|
|
|
@param in The Deserializer object to use
|
|
@return False on any errors, else true
|
|
*/
|
|
virtual bool load(Deserializer& in) = 0;
|
|
|
|
/**
|
|
Get a descriptor for the object name (used in error checking).
|
|
|
|
@return The name of the object
|
|
*/
|
|
virtual string name() const = 0;
|
|
};
|
|
|
|
#endif
|