MCDataContainer.hpp

/*
 *  This file is part of the AiBO+ project
 *
 *  Copyright (C) 2005-2016 Csaba Kertész (csaba.kertesz@gmail.com)
 *
 *  AiBO+ 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  AiBO+ 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 Street #330, Boston, MA 02111-1307, USA.
 *
 */

#pragma once

#include "3rdparty/archives/portable_iarchive.hpp"
#include "3rdparty/archives/portable_oarchive.hpp"
#include "MCBinaryData.hpp"
#include "MCDefs.hpp"
#include "MCTypes.hpp"

#include <boost/archive/binary_iarchive.hpp>
#include <boost/archive/binary_oarchive.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/split_member.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/scoped_ptr.hpp>

#include <string>
#include <list>

#include <stdlib.h>
#include <typeinfo>

class MCBinaryData;

struct MCDataItemBase
{
  MCDataItemBase();
  virtual ~MCDataItemBase();

  virtual void LoadFromArchive(boost::archive::binary_iarchive& archive);
  virtual void SaveToArchive(boost::archive::binary_oarchive& archive) const;
  virtual void LoadFromArchive(eos::portable_iarchive& archive);
  virtual void SaveToArchive(eos::portable_oarchive& archive) const;
  virtual void DeleteData();

  std::string DataName;
  std::string TypeName;
  void* DataPtr;
};

namespace MC
{
typedef std::list<MCDataItemBase*> DataItemBasePtrList;
}

template <typename T>
class MCDataItem : public MCDataItemBase
{
public:
  MCDataItem(const T& data, const std::string& data_name) : MCDataItemBase()
  {
    InitWithCloning(data, data_name);
  }

  MCDataItem(T& data, const std::string& data_name, bool clone_data) : MCDataItemBase()
  {
    if (clone_data)
    {
      InitWithCloning(data, data_name);
      return;
    }
    DataPtr = (void*)&data;
    DataName = data_name;
    // Get the type name
    TypeName = MCGetClassName(&data);
  }

private:

  void InitWithCloning(const T& data, const std::string& data_name)
  {
    T* NewData = new T;

    *NewData = data;
    DataPtr = (void*)NewData;
    DataName = data_name;
    // Get the type name
    TypeName = MCGetClassName(&data);
  }

public:

  T& GetData()
  {
    return *reinterpret_cast<T*>(DataPtr);
  }

  virtual void DeleteData() override
  {
    delete reinterpret_cast<T*>(DataPtr);
    DataPtr = nullptr;
  }

  virtual void LoadFromArchive(eos::portable_iarchive& archive) override
  {
    // cppcheck-suppress clarifyCondition
    archive & *reinterpret_cast<T*>(DataPtr);
  }

  virtual void SaveToArchive(eos::portable_oarchive& archive) const override
  {
    // cppcheck-suppress clarifyCondition
    archive & *reinterpret_cast<T*>(DataPtr);
  }

  virtual void LoadFromArchive(boost::archive::binary_iarchive& archive) override
  {
    // cppcheck-suppress clarifyCondition
    archive & *reinterpret_cast<T*>(DataPtr);
  }

  virtual void SaveToArchive(boost::archive::binary_oarchive& archive) const override
  {
    // cppcheck-suppress clarifyCondition
    archive & *reinterpret_cast<T*>(DataPtr);
  }
};

class MCDataContainer
{
  MC_DISABLE_COPY(MCDataContainer)
  friend class boost::serialization::access;

public:

  MCDataContainer(const std::string& name, bool portable = false);

  virtual ~MCDataContainer();

  bool IsPortable() const;

  void Clear();

  std::string GetName() const;

  MCBinaryData* Encode() const;

  static MCDataContainer* Decode(const MCBinaryData& data, bool portable = false,
                                 MCDataContainer* instance = nullptr);

  void Dump() const;

  MC::StringList GetDataNames() const;

  void AddData(MCDataItemBase& item);

  MCDataItemBase* GetData(const std::string& data_name);

  const MC::DataItemBasePtrList& GetAllData() const;

  void RemoveData(const std::string& data_name);

  virtual MCDataItemBase* GetInputArchiveDataType(const std::string& type_name,
                                                  const std::string& data_name);

private:
  template<class Archive>
  void load(Archive& archive, const unsigned int version);
  template<class Archive>
  void save(Archive& archive, const unsigned int version) const;
  BOOST_SERIALIZATION_SPLIT_MEMBER();

  std::string Name;
  bool Portable;
  MC::DataItemBasePtrList Items;
};

template <typename T>
MCBinaryData* MCEncodeToBinaryData(const T& data, bool portable = true)
{
  boost::scoped_ptr<MCDataContainer> DataContainer(new MCDataContainer("Dummy", portable));

  DataContainer->AddData(*new MCDataItem<T>(data, "Data"));
  return DataContainer->Encode();
}

template <typename T>
boost::shared_ptr<T> MCDecodeFromBinaryData(const MCBinaryData& data, bool portable = true)
{
  boost::scoped_ptr<MCDataContainer> DataContainer(MCDataContainer::Decode(data, portable));

  if (DataContainer.get())
  {
    MCDataItemBase* DataItem = DataContainer->GetData("Data");

    // Type-safe check before cloning
    if (DataItem && MCGetClassName<T>() == DataItem->TypeName)
    {
      return boost::shared_ptr<T>(new T(*reinterpret_cast<T*>(DataItem->DataPtr)));
    }
  }
  return boost::shared_ptr<T>();
}

template <typename T>
std::string MCEncodeToString(const T& data, bool portable = true)
{
  boost::scoped_ptr<MCBinaryData> BinaryData(MCEncodeToBinaryData(data, portable));

  return BinaryData->ToBase64();
}

template <typename T>
boost::shared_ptr<T> MCDecodeFromString(const std::string& data_str, bool portable = true)
{
  boost::scoped_ptr<MCBinaryData> BinaryData(new MCBinaryData);

  BinaryData->FromBase64(data_str);
  return MCDecodeFromBinaryData<T>(*BinaryData, portable);
}