serialization.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Authors: Sebastian Reiter, Martin Rupp
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#ifndef __H__UG__SERIALIZATION__
#define __H__UG__SERIALIZATION__
 
#include <iostream>
#include <vector>
#include <set>
#include <map>
#include <string>
#include <cassert>
#include "log.h"
#include "util/variant.h"
#include "error.h"
 
namespace ug
{
 
 
//todo  It would probably be a good idea to replace the generic Serialize and
//    Deserialize methods with concrete ones, since nasty and hard to trace
//    bugs could be avoided this way. The following Serialize methods already
//    implement serialization for common types. A rather big effort for all
//    the custom types which have to be serialized has to be taken though...
/*
template <class TStream>
void Serialize(TStream& buf, const bool& val)
{
  buf.write((char*)&val, sizeof(bool));
}
 
template <class TStream>
void Deserialize(TStream& buf, bool& valOut)
{
  buf.read((char*)&valOut, sizeof(bool));
}
 
template <class TStream>
void Serialize(TStream& buf, const char& val)
{
  buf.write((char*)&val, sizeof(char));
}
 
template <class TStream>
void Deserialize(TStream& buf, char& valOut)
{
  buf.read((char*)&valOut, sizeof(char));
}
 
template <class TStream>
void Serialize(TStream& buf, const unsigned char& val)
{
  buf.write((char*)&val, sizeof(unsigned char));
}
 
template <class TStream>
void Deserialize(TStream& buf, unsigned char& valOut)
{
  buf.read((char*)&valOut, sizeof(unsigned char));
}
 
template <class TStream>
void Serialize(TStream& buf, const int& val)
{
  buf.write((char*)&val, sizeof(int));
}
 
template <class TStream>
void Deserialize(TStream& buf, int& valOut)
{
  buf.read((char*)&valOut, sizeof(int));
}
 
template <class TStream>
void Serialize(TStream& buf, const unsigned int& val)
{
  buf.write((char*)&val, sizeof(unsigned int));
}
 
template <class TStream>
void Deserialize(TStream& buf, unsigned int& valOut)
{
  buf.read((char*)&valOut, sizeof(unsigned int));
}
 
template <class TStream>
void Serialize(TStream& buf, const size_t& val)
{
  buf.write((char*)&val, sizeof(size_t));
}
 
template <class TStream>
void Deserialize(TStream& buf, size_t& valOut)
{
  buf.read((char*)&valOut, sizeof(size_t));
}
 
template <class TStream>
void Serialize(TStream& buf, const float& val)
{
  buf.write((char*)&val, sizeof(float));
}
 
template <class TStream>
void Deserialize(TStream& buf, float& valOut)
{
  buf.read((char*)&valOut, sizeof(float));
}
 
template <class TStream>
void Serialize(TStream& buf, const double& val)
{
  buf.write((char*)&val, sizeof(int));
}
 
template <class TStream>
void Deserialize(TStream& buf, double& valOut)
{
  buf.read((char*)&valOut, sizeof(double));
}
*/
 
template <class TStream, class T>
void Serialize(TStream& buf, const T& val)
{
  buf.write((char*)&val, sizeof(T));
}
 
template <class TStream, class T>
void Deserialize(TStream& buf, T& valOut)
{
  buf.read((char*)&valOut, sizeof(T));
}
 
template<typename T, class TIStream>
T Deserialize(TIStream &stream)
{
  T t;
  Deserialize(stream, t);
  return t;
}
 
 
template <class TStream, class T>
void Deserialize(TStream& buf, const T& valOut);
 
 
//  All specializations should be pre-declared here!
//  This is important, so that the different methods know of each other.
template <class T1, class T2, class TOStream>
void Serialize(TOStream& buf, const std::pair<T1, T2>& v);
 
template <class T1, class T2, class TIStream>
void Deserialize(TIStream& buf, std::pair<T1, T2>& v);
 
template <class T, class TOStream>
void Serialize(TOStream& buf, const std::set<T>& m);
 
template <class T, class TIStream>
void Deserialize(TIStream& buf, std::set<T>& myset);
 
template <class TOStream>
void Serialize(TOStream& buf, const std::string& str);
 
template <class TIStream>
void Deserialize(TIStream& buf, std::string& str);
 
template <class TOStream>
void Serialize(TOStream& buf, const Variant& v);
 
template <class TIStream>
void Deserialize(TIStream& buf, Variant& v);
 
template <class T, class TOStream>
void Serialize(TOStream& buf, const std::vector<T>& vec);
 
template <class T, class TIStream>
void Deserialize(TIStream& buf, std::vector<T>& vec);
 
template <class TOStream>
inline void Serialize(TOStream& buf, const std::vector<bool>::reference& boolRef);
 
template <class TIStream>
inline void Deserialize(TIStream& buf, std::vector<bool>::reference boolRef);
 
template <class Key, class T, class TOStream>
void Serialize(TOStream& buf, const std::map<Key, T>& m);
 
template <class Key, class T, class TIStream>
void Deserialize(TIStream& buf, std::map<Key, T>& m);
 
 
 
template <class T1, class T2, class TOStream>
void Serialize(TOStream& buf, const std::pair<T1, T2>& v)
{
  Serialize(buf, v.first);
  Serialize(buf, v.second);
}
 
template <class T1, class T2, class TIStream>
void Deserialize(TIStream& buf, std::pair<T1, T2>& v)
{
  Deserialize(buf, v.first);
  Deserialize(buf, v.second);
}
 
 
template <class T, class TOStream>
void Serialize(TOStream& buf, const std::set<T>& m)
{
  Serialize<size_t>(buf, m.size());
  for(typename std::set<T>::const_iterator it = m.begin(); it != m.end(); ++it)
    Serialize<T>(buf, *it);
}
 
template <class T, class TIStream>
void Deserialize(TIStream& buf, std::set<T>& myset)
{
  myset.clear();
  size_t size = Deserialize<size_t>(buf);
  T t;
  for(size_t i = 0; i < size; ++i)
  {
    Deserialize<T>(buf, t);
    // using myset.end() because data t is sorted.
    myset.insert (myset.end(), t);
  }
}
 
 
template <class TOStream>
void Serialize(TOStream& buf, const std::string& str)
{
  size_t len = str.length();
  Serialize(buf, len);
  if(len > 0)
    buf.write(str.c_str(), sizeof(char) * len);
}
 
template <class TIStream>
void Deserialize(TIStream& buf, std::string& str)
{
//  the buffers allow us to read small strings fast.
//  for bigger ones we have to temporarily reserve memory.
  char staticBuf[64];
  char* flexBuf = NULL;
  char* tBuf = staticBuf;
 
  size_t len = Deserialize<size_t>(buf);
 
//  check whether we have to allocate memory
//  don't forget that we have to append a zero at the end
  if(len >= 63){
    flexBuf = new char[len + 1];
    tBuf = flexBuf;
  }
 
  if(len > 0)
    buf.read(tBuf, sizeof(char) * len);
  tBuf[len] = 0;
 
//  assign data to the out-string
  str = tBuf;
 
//  clean up
  if(flexBuf)
    delete[] flexBuf;
}
 
 
 
template <class TOStream>
void Serialize(TOStream& buf, const Variant& v)
{
  Serialize(buf, int(v.type()));
  switch(v.type()){
    case Variant::VT_INVALID: break;
    case Variant::VT_BOOL:    Serialize(buf, v.to_bool()); break;
    case Variant::VT_INT:   Serialize(buf, v.to_int()); break;
    case Variant::VT_FLOAT:   Serialize(buf, v.to_float()); break;
    case Variant::VT_DOUBLE:  Serialize(buf, v.to_double()); break;
    case Variant::VT_CSTRING: Serialize(buf, std::string(v.to_c_string())); break;
    case Variant::VT_STDSTRING: Serialize(buf, v.to_std_string()); break;
    case Variant::VT_POINTER: break;
 
    default:
      UG_THROW("Unknown variant type in Serialize:" << v.type());
      break;
  }
}
 
 
template <class TIStream>
void Deserialize(TIStream& buf, Variant& v)
{
  int type = Deserialize<int>(buf);
  switch(type){
    case Variant::VT_INVALID: v = Variant(); break;
    case Variant::VT_BOOL:    v = Variant(Deserialize<bool>(buf)); break;
    case Variant::VT_INT:   v = Variant(Deserialize<int>(buf)); break;
    case Variant::VT_FLOAT:   v = Variant(Deserialize<float>(buf)); break;
    case Variant::VT_DOUBLE:  v = Variant(Deserialize<double>(buf)); break;
    case Variant::VT_CSTRING: // fallthrough
    case Variant::VT_STDSTRING: v = Variant(Deserialize<std::string>(buf)); break;
 
    case Variant::VT_POINTER:{
      void* val = NULL;
      v = Variant(val);
    } break;
 
    default:
      UG_THROW("Unknown variant type in Deserialize: " << type);
      break;
  }
}
 
 
template <class T, class TOStream>
void Serialize(TOStream& buf, const std::vector<T>& vec)
{
  size_t size = vec.size();
  Serialize(buf, size);
  for(size_t i = 0; i < size; ++i){
    Serialize(buf, vec[i]);
  }
}
 
template <class T, class TIStream>
void Deserialize(TIStream& buf, std::vector<T>& vec)
{
  vec.clear();
  size_t size = Deserialize<size_t>(buf);
  vec.resize(size);
  for(size_t i = 0; i < size; ++i){
    Deserialize(buf, vec[i]);
  }
}
 
 
template<class TIStream>
void Serialize(TIStream &buf, const std::vector<bool> &vec)
{
  size_t size=vec.size();
  Serialize<size_t>(buf, size);
  int j=0;
  char a=0;
  for(size_t i = 0; i < size; ++i)
  {
    if(vec[i]) a |= (1 << j);
    if(++j == 8)
    {
      Serialize<char>(buf, a);
      a = 0;
      j = 0;
    }
  }
  if(j) Serialize<char>(buf, a);
}
 
template<class TIStream>
void Deserialize(TIStream &buf, std::vector<bool> &vec)
{
  vec.clear();
  size_t size = Deserialize<size_t>(buf);
  vec.resize(size);
  int j=8;
  char a=0;
  for(size_t i = 0; i < size; ++i, ++j)
  {
    if(j==8)
    {
      Deserialize<char>(buf, a);
      j=0;
    }
    vec[i] = a & (1 << j);
    j++;
  }
}
 
template <class TOStream>
inline void Serialize(TOStream& buf, const std::vector<bool>::reference& boolRef)
{
  char b = ((bool)boolRef) ? 1 : 0;
  buf.write(&b, sizeof(char));
}
 
// * This function is to avoid surprises with vector<bool>
// note: boolRef is not &boolRef.
template <class TIStream>
inline void Deserialize(TIStream& buf, std::vector<bool>::reference boolRef)
{
  char b;
  buf.read(&b, sizeof(char));
  boolRef = (bool)(b == 1);
}
 
 
 
template <class Key, class T, class TOStream>
void Serialize(TOStream& buf, const std::map<Key, T>& m)
{
  Serialize(buf, m.size());
 
  for(typename std::map<Key, T>::const_iterator it = m.begin(); it != m.end(); ++it)
  {
    Serialize(buf, it->first);
    Serialize(buf, it->second);
  }
}
 
template <class Key, class T, class TIStream>
void Deserialize(TIStream& buf, std::map<Key, T>& m)
{
  m.clear();
  size_t size = Deserialize<size_t>(buf);
  for(size_t i = 0; i < size; ++i)
  {
    Key k;
    Deserialize(buf, k);
    Deserialize(buf, m[k]);
  }
}
 
// end group ugbase_common
 
}// end of namespace
 
 
#endif