ostream_proxy.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library 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.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_OSTREAM_PROXY_H
#define LIBMESH_OSTREAM_PROXY_H



// C++ includes
#include <iostream>

// Local Includes
// We don't use anything libMesh-specific here (yet)
// #include "libmesh/libmesh_common.h"


namespace libMesh
{

// Forward Declarations



// ------------------------------------------------------------
// OStreamProxy class definition
//
// This class is intended to be reseatable like a pointer-to-ostream
// for flexibility, but to look like a reference when used to produce
// less awkward user code.
//
// It is up to the user to ensure that the target ostream

template <typename charT=char, typename traits=std::char_traits<charT> >
class BasicOStreamProxy
{
public:
  typedef std::basic_ostream<charT,traits> streamT;

  typedef std::basic_streambuf<charT,traits> streambufT;

  BasicOStreamProxy (streamT& target) : _target(&target) {}

  BasicOStreamProxy (BasicOStreamProxy& old) : _target(old._target) {}

  BasicOStreamProxy& operator= (streamT& target)
  {
    _target = &target;
    return *this;
  }

  BasicOStreamProxy& operator= (const BasicOStreamProxy& old)
  {
    _target = old._target;
    return *this;
  }

  ~BasicOStreamProxy () {}

  //
  // Functions that get passed to the proxied target:
  //

  operator streamT&() { return *_target; }

  operator const streamT&() const { return *_target; }

  template<typename T>
  BasicOStreamProxy& operator<< (const T& in) {
    (*_target) << in; return *this;
  }

  BasicOStreamProxy& operator<< (streamT& (*in)(streamT&)) {
    (*_target) << in; return *this;
  }

  BasicOStreamProxy& operator<< (std::basic_ios<charT,traits>& (*in)(std::basic_ios<charT,traits>&)) {
    (*_target) << in; return *this;
  }

  BasicOStreamProxy& operator<< (std::ios_base& (*in)(std::ios_base&)) {
    (*_target) << in; return *this;
  }

  streambufT* rdbuf () const { return _target->rdbuf(); }

  streambufT* rdbuf ( streambufT* sb ) { return _target->rdbuf(sb); }

  BasicOStreamProxy& flush () { _target->flush(); return *this; }

  std::ios_base::fmtflags flags ( ) const
  { return _target->flags(); }

  std::ios_base::fmtflags flags ( std::ios_base::fmtflags fmtfl )
  { return _target->flags(fmtfl); }

  std::ios_base::fmtflags setf ( std::ios_base::fmtflags fmtfl )
  { return _target->setf(fmtfl); }

  std::ios_base::fmtflags setf ( std::ios_base::fmtflags fmtfl,
                                 std::ios_base::fmtflags mask )
  { return _target->setf(fmtfl, mask); }

  void unsetf ( std::ios_base::fmtflags mask )
  { _target->unsetf(mask); }

  std::streamsize precision () const
  { return _target->precision(); }

  std::streamsize precision ( std::streamsize prec )
  { return _target->precision(prec); }

  //
  // Functions that affect the Proxy class:
  //

  void reset (streamT& target) { _target = &target; }

  streamT* get() {
    return _target;
  }

  const streamT* get() const {
    return _target;
  }

private:
  streamT* _target;
};

typedef BasicOStreamProxy<> OStreamProxy;

} // namespace libMesh

#endif // LIBMESH_OSTREAM_PROXY_H