TextFileIArchive.h

#ifndef UTIL_TEXT_FILE_I_ARCHIVE_H
#define UTIL_TEXT_FILE_I_ARCHIVE_H
 
/*
* Util Package - C++ Utilities for Scientific Computation
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include "Byte.h"
#include "serialize.h"
 
#include <util/space/Vector.h>
#include <util/space/IntVector.h>
 
#include <complex>
#include <string>
#include <vector>
#include <fstream>
 
namespace Util
{

   class TextFileIArchive
   {
 
   public:
 
      // Static functions

      static bool is_saving();

      static bool is_loading();
 
      // Lifetime and file control

      TextFileIArchive();

      TextFileIArchive(std::string filename);

      TextFileIArchive(std::ifstream& file);

      virtual ~TextFileIArchive();

      std::ifstream& file();
 
      // Overloaded >> (extraction) and & operator templates.

      template <typename T>
      TextFileIArchive& operator >> (T& data);

      template <typename T>
      TextFileIArchive& operator & (T& data);

      template <typename T, size_t N>
      TextFileIArchive& operator >> (T (& data)[N]);

      template <typename T, size_t N>
      TextFileIArchive& operator & (T (& data)[N]);
 
      // Unpack functions (building blocks)

      template <typename T> 
      void unpack(T& data);

      template <typename T> 
      void unpack(T* array, int n);

      template <typename T> 
      void unpack(T* array, int m, int n, int np);
 
   private:

      std::ifstream* filePtr_;

      unsigned int  version_;

      bool createdFile_;
 
   };
 
   // Inline methods
 
   inline bool TextFileIArchive::is_saving()
   {  return false; }
 
   inline bool TextFileIArchive::is_loading()
   {  return true; }
 
   // Inline non-static methods
 
   /*
   * Load one object via operator >>.
   */
   template <typename T>
   inline TextFileIArchive& TextFileIArchive::operator >> (T& data)
   {   
      serialize(*this, data, version_); 
      return *this;
   }
 
   /*
   * Load one object via operator &.
   */
   template <typename T>
   inline TextFileIArchive& TextFileIArchive::operator & (T& data)
   {   
      serialize(*this, data, version_); 
      return *this;
   }
 
   /*
   * Load a fixed size array of objects via operator >>.
   */
   template <typename T, size_t N>
   inline TextFileIArchive& TextFileIArchive::operator >> (T (&data)[N])
   {
      for (size_t i = 0; i < N; ++i) {   
         serialize(*this, data[i], version_); 
      }
      return *this;
   }
 
   /*
   * Load a fixed size array of objects via operator &.
   */
   template <typename T, size_t N>
   inline TextFileIArchive& TextFileIArchive::operator & (T (&data)[N])
   {
      for (size_t i = 0; i < N; ++i) {
         serialize(*this, data[i], version_); 
      }
      return *this;
   }
 
   // Unpack method templates
 
   /*
   * Load a single object of type T.
   */
   template <typename T>
   inline void TextFileIArchive::unpack(T& data)
   {  *filePtr_ >> data; }
 
   /*
   * Load a C array.
   */
   template <typename T>
   inline void TextFileIArchive::unpack(T* array, int n)
   {
      for (int i=0; i < n; ++i) {
         *filePtr_ >> array[i];
      }
   }
 
   /*
   * Bitwise pack a 2D C-array of objects of type T.
   */
   template <typename T>
   void TextFileIArchive::unpack(T* array, int m, int n, int np)
   {
      int i, j;
      for (i = 0; i < m; ++i) {
         for (j = 0; j < n; ++j) {
            *filePtr_ >> array[i*np + j];
         }
      }
   }
 
   /*
   * Load a single char.
   */
   template <>
   inline void TextFileIArchive::unpack(char& data)
   {   filePtr_->get(data); }
 
   /*
   * Load a C-array of characters.
   */
   template <>
   inline void TextFileIArchive::unpack(char* array, int n)
   {
      filePtr_->get(array, n+1,'\0');
   }
 
   // Explicit serialize functions for primitive types
 
   /*
   * Load a bool from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, bool& data, 
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load a char from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, char& data, 
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load an unsigned int from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, unsigned int& data, 
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load an int from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, int& data, 
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load an unsigned long int from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, unsigned long& data,  
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load a long int from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, long& data,  
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load a float from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, float& data, 
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load a double from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, double& data, 
                         const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load a std::vector from a TextFileIArchive.
   */
   template <typename T>
   void serialize(TextFileIArchive& ar, std::vector<T>& data, 
                  const unsigned int version)
   {
      T element;
      std::size_t size;
      ar.unpack(size);
      data.reserve(size);
      data.clear();
      for (size_t i = 0; i < size; ++i) {
         ar & element;
         data.push_back(element);
      }
   }
 
   // Explicit serialize functions for std library types
 
   /*
   * Load a std::complex<float> from a TextFileIArchive.
   */
   template <>
   inline 
   void serialize(TextFileIArchive& ar, std::complex<float>& data, 
                  const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load a std::complex<double> from a TextFileIArchive.
   */
   template <>
   inline 
   void serialize(TextFileIArchive& ar, std::complex<double>& data, 
                  const unsigned int version)
   {  ar.unpack(data); }
 
   /*
   * Load a std::string from a TextFileIArchive.
   */
   template <>
   void serialize(TextFileIArchive& ar, std::string& data, 
                  const unsigned int version);
 
   // Explicit serialize functions for namespace Util types
 
   /*
   * Load a Util::Vector from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, Vector& data, 
                         const unsigned int version)
   {  ar.unpack(data); } 
 
   /*
   * Load a Util::IntVector from a TextFileIArchive.
   */
   template <>
   inline void serialize(TextFileIArchive& ar, IntVector& data, 
                         const unsigned int version)
   {  ar.unpack(data); }
 
}
#endif