libigl_Martin/include/igl/xml/serialize_xml.h

//
// Copyright (C) 2014 Christian Sch�ller <schuellchr@gmail.com>
//
// This Source Code Form is subject to the terms of the Mozilla Public License
// v. 2.0. If a copy of the MPL was not distributed with this file, You can
// obtain one at http://mozilla.org/MPL/2.0/.
// -----------------------------------------------------------------------------
// Functions to save and load a serialization of fundamental c++ data types to
// and from a xml file. STL containers, Eigen matrix types and nested data
// structures are also supported. To serialize a user defined class implement
// the interface XMLSerializable or XMLSerializableBase.
//
// See also: serialize.h
// -----------------------------------------------------------------------------

#ifndef IGL_SERIALIZABLE_XML_H
#define IGL_SERIALIZABLE_XML_H

#include "../igl_inline.h"

#include <type_traits>
#include <iostream>
#include <vector>
#include <set>
#include <map>

#include <Eigen/Dense>
#include <Eigen/Sparse>

#include <igl/serialize.h>

#include "tinyxml2.h"

//#define SERIALIZE_XML(x) igl::serialize_xml(x,#x,doc,element);
//#define DESERIALIZE_XML(x) igl::deserialize_xml(x,#x,,doc,element);

namespace igl
{
  // serializes the given object either to a xml file or to the provided doc data
  //
  // Templates:
  //   T  type of the object to serialize
  // Inputs:
  //   obj        object to serialize
  //   objectName unique object name,used for the identification
  //   filename   name of the file containing the serialization
  //   binary     set to true to serialize the object in binary format (faster for big data)
  //   overwrite  set to true to update the serialization in an existing xml file
  //   element    tinyxml2 virtual representation of the current xml node
  // Outputs:
  //   doc        contains current tinyxml2 virtual representation of the xml data
  //
  template <typename T>
  IGL_INLINE void serialize_xml(const T& obj,const std::string& filename);
  template <typename T>
  IGL_INLINE void serialize_xml(const T& obj,const std::string& objectName,const std::string& filename, bool binary = false,bool update = false);
  template <typename T>
  IGL_INLINE void serialize_xml(const T& obj,const std::string& objectName,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,bool binary = false);

  // deserializes the given data from a xml file or doc data back to the provided object
  //
  // Templates:
  //   T  type of the object to serialize
  // Inputs:
  //
  //   objectName unique object name,used for the identification
  //   filename   name of the file containing the serialization
  //   binary     set to true to serialize the object in binary format (faster for big data)
  //   overwrite  set to true to update the serialization in an existing xml file
  //   doc        contains current tinyxml2 virtual representation of the xml data
  //   element    tinyxml2 virtual representation of the current xml node
  // Outputs:
  //   obj        object to load back serialization to
  //
  template <typename T>
  IGL_INLINE void deserialize_xml(T& obj,const std::string& filename);
  template <typename T>
  IGL_INLINE void deserialize_xml(T& obj,const std::string& objectName,const std::string& filename);
  template <typename T>
  IGL_INLINE void deserialize_xml(T& obj,const std::string& objectName,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element);

  // interface for user defined types
  struct XMLSerializableBase : public SerializableBase
  {
    virtual void Serialize(std::vector<char>& buffer) const = 0;
    virtual void Deserialize(const std::vector<char>& buffer) = 0;
    virtual void Serialize(tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element) const = 0;
    virtual void Deserialize(const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element) = 0;
  };

  // Convenient interface for user defined types
  class XMLSerializable: public XMLSerializableBase
  {
  private:

    template <typename T>
    struct XMLSerializationObject: public XMLSerializableBase
    {
      bool Binary;
      std::string Name;
      T* Object;

      void Serialize(std::vector<char>& buffer) const {
        igl::serialize(*Object,Name,buffer);
      }

      void Deserialize(const std::vector<char>& buffer) {
        igl::deserialize(*Object,Name,buffer);
      }

      void Serialize(tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element) const {
        igl::serialize_xml(*Object,Name,doc,element,Binary);
      }

      void Deserialize(const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element) {
        igl::deserialize_xml(*Object,Name,doc,element);
      }
    };

    mutable bool initialized;
    mutable std::vector<XMLSerializableBase*> objects;

  public:

    // Override this function to add your member variables which should be serialized
    IGL_INLINE virtual void InitSerialization() = 0;

    // Following functions can be overridden to handle the specific events.
    // Return false to prevent the de-/serialization of an object.
    IGL_INLINE virtual bool PreSerialization() const;
    IGL_INLINE virtual void PostSerialization() const;
    IGL_INLINE virtual bool PreDeserialization();
    IGL_INLINE virtual void PostDeserialization();

    // Default implementation of XMLSerializable interface
    IGL_INLINE void Serialize(std::vector<char>& buffer) const;
    IGL_INLINE void Deserialize(const std::vector<char>& buffer);
    IGL_INLINE void Serialize(tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element) const;
    IGL_INLINE void Deserialize(const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element);

    // Default constructor, destructor, assignment and copy constructor
    IGL_INLINE XMLSerializable();
    IGL_INLINE XMLSerializable(const XMLSerializable& obj);
    IGL_INLINE ~XMLSerializable();
    IGL_INLINE XMLSerializable& operator=(const XMLSerializable& obj);

    // Use this function to add your variables which should be serialized
    template <typename T>
    IGL_INLINE void Add(T& obj,std::string name,bool binary = false);
  };

  // internal functions
  namespace detail_xml
  {
    // fundamental types
    template <typename T>
    IGL_INLINE typename std::enable_if<std::is_fundamental<T>::value>::type serialize(const T& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template <typename T>
    IGL_INLINE typename std::enable_if<std::is_fundamental<T>::value>::type deserialize(T& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    // std::string
    IGL_INLINE void serialize(const std::string& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    IGL_INLINE void deserialize(std::string& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    // XMLSerializableBase
    template <typename T>
    IGL_INLINE typename std::enable_if<std::is_base_of<XMLSerializableBase,T>::value>::type serialize(const T& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template <typename T>
    IGL_INLINE typename std::enable_if<std::is_base_of<XMLSerializableBase,T>::value>::type deserialize(T& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    // STL containers
    template <typename T1, typename T2>
    IGL_INLINE void serialize(const std::pair<T1,T2>& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template <typename T1,typename T2>
    IGL_INLINE void deserialize(std::pair<T1,T2>& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    template <typename T1,typename T2>
    IGL_INLINE void serialize(const std::vector<T1,T2>& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template <typename T1,typename T2>
    IGL_INLINE void deserialize(std::vector<T1,T2>& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    template <typename T>
    IGL_INLINE void serialize(const std::set<T>& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template <typename T>
    IGL_INLINE void deserialize(std::set<T>& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    template <typename T1,typename T2>
    IGL_INLINE void serialize(const std::map<T1,T2>& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template <typename T1,typename T2>
    IGL_INLINE void deserialize(std::map<T1,T2>& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    // Eigen types
    template<typename T,int R,int C,int P,int MR,int MC>
    IGL_INLINE void serialize(const Eigen::Matrix<T,R,C,P,MR,MC>& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template<typename T,int R,int C,int P,int MR,int MC>
    IGL_INLINE void deserialize(Eigen::Matrix<T,R,C,P,MR,MC>& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    template<typename T,int P,typename I>
    IGL_INLINE void serialize(const Eigen::SparseMatrix<T,P,I>& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template<typename T,int P,typename I>
    IGL_INLINE void deserialize(Eigen::SparseMatrix<T,P,I>& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    // pointers
    template <typename T>
    IGL_INLINE typename std::enable_if<std::is_pointer<T>::value>::type serialize(const T& obj,tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    template <typename T>
    IGL_INLINE typename std::enable_if<std::is_pointer<T>::value>::type deserialize(T& obj,const tinyxml2::XMLDocument* doc,const tinyxml2::XMLElement* element,const std::string& name);

    // helper functions
    tinyxml2::XMLElement* getElement(tinyxml2::XMLDocument* doc,tinyxml2::XMLElement* element,const std::string& name);
    IGL_INLINE void getAttribute(const char* src,bool& dest);
    IGL_INLINE void getAttribute(const char* scr,char& dest);
    IGL_INLINE void getAttribute(const char* src,std::string& dest);
    IGL_INLINE void getAttribute(const char* src,float& dest);
    IGL_INLINE void getAttribute(const char* src,double& dest);
    template<typename T>
    IGL_INLINE typename std::enable_if<std::is_integral<T>::value && std::is_unsigned<T>::value>::type getAttribute(const char* src,T& dest);
    template<typename T>
    IGL_INLINE typename std::enable_if<std::is_integral<T>::value && !std::is_unsigned<T>::value>::type getAttribute(const char* src,T& dest);
    IGL_INLINE void replaceSubString(std::string& str,const std::string& search,const std::string& replace);
    IGL_INLINE void encodeXMLElementName(std::string& name);
    IGL_INLINE void decodeXMLElementName(std::string& name);
    IGL_INLINE std::string base64_encode(unsigned char const* bytes_to_encode,unsigned int in_len);
    IGL_INLINE std::string base64_decode(std::string const& encoded_string);

    // compile time type serializable check
    template <typename T>
    struct is_stl_container { static const bool value = false; };
    template <typename T1,typename T2>
    struct is_stl_container<std::pair<T1,T2> > { static const bool value = true; };
    template <typename T1,typename T2>
    struct is_stl_container<std::vector<T1,T2> > { static const bool value = true; };
    template <typename T>
    struct is_stl_container<std::set<T> > { static const bool value = true; };
    template <typename T1,typename T2>
    struct is_stl_container<std::map<T1,T2> > { static const bool value = true; };

    template <typename T>
    struct is_eigen_type { static const bool value = false; };
    template <typename T,int R,int C,int P,int MR,int MC>
    struct is_eigen_type<Eigen::Matrix<T,R,C,P,MR,MC> > { static const bool value = true; };
    template <typename T,int P,typename I>
    struct is_eigen_type<Eigen::SparseMatrix<T,P,I> > { static const bool value = true; };

    template <typename T>
    struct is_serializable {
      using T0 = typename  std::remove_pointer<T>::type;
      static const bool value = std::is_fundamental<T0>::value || std::is_same<std::string,T0>::value || std::is_base_of<XMLSerializableBase,T0>::value
        || is_stl_container<T0>::value || is_eigen_type<T0>::value;
    };
  }
}

#ifndef IGL_STATIC_LIBRARY
  #include "serialize_xml.cpp";
#endif

#endif