rewinder.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2013 Joerg Henrichs
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//
//  This program 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
#ifndef HEADER_REWINDER_HPP
#define HEADER_REWINDER_HPP
 
#include <cassert>
#include <functional>
#include <string>
#include <memory>
#include <vector>
 
class BareNetworkString;
 
enum RewinderName : char
{
    RN_ITEM_MANAGER = 0x01,
    RN_KART = 0x02,
    RN_RED_FLAG = 0x03,
    RN_BLUE_FLAG = 0x04,
    RN_CAKE = 0x05,
    RN_BOWLING = 0x06,
    RN_PLUNGER = 0x07,
    RN_RUBBERBALL = 0x08,
    RN_PHYSICAL_OBJ = 0x09
};
 
class Rewinder : public std::enable_shared_from_this<Rewinder>
{
protected:
    void setUniqueIdentity(const std::string& uid)  { m_unique_identity = uid; }
private:
    std::string m_unique_identity;
 
public:
    Rewinder(const std::string& ui = "")             { m_unique_identity = ui; }
 
    virtual ~Rewinder() {}
 
    virtual void saveTransform() = 0;
 
    virtual void computeError() = 0;
 
    virtual BareNetworkString* saveState(std::vector<std::string>* ru) = 0;
 
    virtual void undoEvent(BareNetworkString *buffer) = 0;
 
    virtual void rewindToEvent(BareNetworkString *buffer) = 0;
 
    virtual void restoreState(BareNetworkString *buffer, int count) = 0;
 
    virtual void undoState(BareNetworkString *buffer) = 0;
 
    // -------------------------------------------------------------------------
    virtual void reset() {}
    // -------------------------------------------------------------------------
    virtual std::function<void()> getLocalStateRestoreFunction()
                                                             { return nullptr; }
    // -------------------------------------------------------------------------
    const std::string& getUniqueIdentity() const
    {
        assert(!m_unique_identity.empty() && m_unique_identity.size() < 255);
        return m_unique_identity;
    }
    // -------------------------------------------------------------------------
    bool rewinderAdd();
    // -------------------------------------------------------------------------
    template<typename T> std::shared_ptr<T> getShared()
                    { return std::dynamic_pointer_cast<T>(shared_from_this()); }
 
};   // Rewinder
#endif