JBinaryFileWriter.hh

Go to the documentation of this file.

#ifndef __JIO__JBINARYFILEWRITER__
#define __JIO__JBINARYFILEWRITER__

#include <ostream>

#include "JLang/JAccessibleBinaryStream.hh"
#include "JLang/JObjectOutput.hh"
#include "JLang/JTypeList.hh"
#include "JLang/JNullType.hh"

#include "JIO/JStreamIO.hh"
#include "JIO/JWriterObjectOutput.hh"


/**
 * \author mdejong
 */

namespace JIO {}
namespace JPP { using namespace JIO; }

namespace JIO {

  using JLANG::JAccessibleObjectOutput;
  using JLANG::JAccessibleBinaryOutputStream;
  using JLANG::JObjectOutput;
  using JLANG::JNullOutput;
  using JLANG::JTypeList;
  using JLANG::JNullType;

  /**
   * Auxiliary class for object writing to binary stream.
   */
  template<class T, const bool = JLANG::JConversion<T,JSerialisable>::is_derived>
  class JBinaryWriterObjectOutput;


  /**
   * Implementation of object output for binary stream compatible data types.
   *
   * This class implements the JLANG::JObjectOutput interface.
   */
  template<class T>
  class JBinaryWriterObjectOutput<T,true> :
    public JWriterObjectOutput<T>
  {
  protected:
    /**
     * Constructor.
     *
     * \param  writer     JWriter output
     */
    JBinaryWriterObjectOutput(JWriter& writer) :
      JWriterObjectOutput<T>(writer)
    {}
  };


  /**
   * Implementation of object output for binary stream incompatible data types.
   *
   * This class implements the JLANG::JObjectOutput interface by doing nothing.
   */
  template<class T>
  class JBinaryWriterObjectOutput<T,false> :
    public JNullOutput<T>
  {
  protected:
    /**
     * Constructor.
     *
     * \param  writer     JWriter output
     */
    JBinaryWriterObjectOutput(JWriter& writer)
    {}
  };


  /**
   * Implementation of object output to binary file for single data type.
   *
   * This class implements the JLANG::JObjectOutput interface.
   */
  template<class T>
  class JBinaryWriter :
    public JBinaryWriterObjectOutput<T>
  {
  protected:
    /**
     * Constructor.
     *
     * \param  writer     JWriter output
     */
    JBinaryWriter(JWriter& writer) :
      JBinaryWriterObjectOutput<T>(writer)
    {}
  };
  

  /**
   * Implementation of object output to binary file for multiple data types.
   *
   * This class recursively implements the JLANG::JObjectOutput interface
   * for all data types by deriving from:
   *  - JBinaryWriter<JHead_t>; and
   *  - JBinaryWriter<JTail_t>.
   */
  template<class JHead_t, class JTail_t>
  class JBinaryWriter< JTypeList<JHead_t, JTail_t> > :
    public virtual JObjectOutput< JTypeList<JHead_t, JTail_t> >,
    public JBinaryWriter<JHead_t>,
    public JBinaryWriter<JTail_t>

  {
  protected:
    /**
     * Constructor.
     *
     * \param  writer     JWriter output
     */
    JBinaryWriter(JWriter& writer) :
      JBinaryWriter<JHead_t>(writer),
      JBinaryWriter<JTail_t>(writer)
    {}
  };


  /**
   * Terminator class of recursive JBinaryWriter class.
   */
  template<class JHead_t>
  class JBinaryWriter< JTypeList<JHead_t, JNullType> > :
    public JBinaryWriter<JHead_t>
  {
  protected:
    /**
     * Constructor.
     *
     * \param  writer     JWriter output
     */
    JBinaryWriter(JWriter& writer) :
      JBinaryWriter<JHead_t>(writer)
    {}
  };


  /**
   * Object(s) writing to binary file (i.e.\ .jpp).
   *
   * This class implements the JLANG::JAccessibleObjectOutput interface.
   */
  template<class T>
  class JBinaryFileWriter :
    public    JAccessibleObjectOutput<T>,
    public    JAccessibleBinaryOutputStream,
    protected JStreamWriter,
    public    JBinaryWriter<T>
  {
  public:
    /**
     * Default constructor.
     */
    JBinaryFileWriter() :
      JAccessibleBinaryOutputStream(),
      JStreamWriter   (static_cast<std::ostream&>(*this)),
      JBinaryWriter<T>(static_cast<JWriter&>     (*this))
    {}
  };
}

#endif