formatters.hpp

Go to the documentation of this file.

/*****************************************************************************
** Ifdefs
*****************************************************************************/

#ifndef ECL_CONTAINERS_PUSH_AND_POP_FORMATTERS_HPP_
#define ECL_CONTAINERS_PUSH_AND_POP_FORMATTERS_HPP_

/*****************************************************************************
 ** Includes
 *****************************************************************************/

#include <cmath>
#include <ecl/config/macros.hpp>
#include <ecl/formatters/common.hpp>
#include <ecl/formatters/number.hpp>
#include <ecl/formatters/floats.hpp>
#include "../common/formatters.hpp"
#include "../push_and_pop.hpp"

/*****************************************************************************
 ** Namespaces
 *****************************************************************************/

namespace ecl
{
namespace formatters
{

/*****************************************************************************
 ** Using
 *****************************************************************************/

template<typename Type, size_t N>
class ECL_PUBLIC PushAndPopFormatter
{
public:
  virtual ~PushAndPopFormatter()
  {}
  ecl::PushAndPop<Type,N>& operator()(const ecl::PushAndPop<Type,N> &container) {
    return container;
  }
};

/*****************************************************************************
 ** Interface [ByteArrayFormatter]
 *****************************************************************************/

template<typename Byte, size_t N>
class ECL_PUBLIC BytePushAndPopFormatter
{
public:
  BytePushAndPopFormatter() : ready_to_format(false)
  {};
  BytePushAndPopFormatter<Byte,N>& operator()(const ecl::PushAndPop<Byte,N> &push_and_pop)
  {
    push_and_pop_container = &push_and_pop;
    ready_to_format = true;
    return *this;
  }

  virtual ~BytePushAndPopFormatter()
  {}
  template <typename OutputStream, typename CharType, size_t M>
  friend OutputStream& operator << (OutputStream& ostream, const BytePushAndPopFormatter<CharType,M> &formatter) ecl_assert_throw_decl(StandardException);

private:
  const typename ecl::PushAndPop<Byte,N> *push_and_pop_container;
  bool ready_to_format;
};

/*****************************************************************************
 ** Implementation [ByteArrayFormatter]
 *****************************************************************************/

template <typename OutputStream, typename CharType, size_t M>
OutputStream& operator <<(OutputStream& ostream, const BytePushAndPopFormatter<CharType, M> &formatter)
ecl_assert_throw_decl(StandardException)
{
  ecl_assert_throw(formatter.ready_to_format, StandardException(LOC,UsageError,"The formatter cannot print any data - "
          "either there is no data available, or you have tried to use the "
          "formatter more than once in a single streaming operation. "
          "C++ produces unspecified results when functors are used multiply "
          "in the same stream sequence, so this is not permitted here.") );

  ecl::Format<CharType> format(-1, ecl::NoAlign, ecl::Hex);
  ostream  << "[ ";
  for ( unsigned int i = 0; i < formatter.push_and_pop_container->size(); ++i ) {
    ostream << format((*(formatter.push_and_pop_container))[i]) << " ";
  }
  ostream << "]";
  ostream.flush();
  return ostream;
}

/*****************************************************************************
 ** Specialisations [PushAndPopFormatter][Char Types]
 *****************************************************************************/

template<size_t N>
class ECL_PUBLIC PushAndPopFormatter< unsigned char,N >
{
public:
  typename ecl::formatters::BytePushAndPopFormatter<unsigned char, N>& operator()(const ecl::PushAndPop<unsigned char, N> &container) {
    return formatter(container);
  }

private:
  typename ecl::formatters::BytePushAndPopFormatter<unsigned char, N> formatter;
};


/*****************************************************************************
** Not Yet Implemented - formatters for signed, char types
*****************************************************************************/

} // namespace formatters
} // namespace ecl


#endif /* ECL_CONTAINERS_PUSH_AND_POP_FORMATTERS_HPP_ */