ConsoleStream.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
class OutputWarehouse;

// C++ includes
#include <iostream>
#include <sstream>
#include <memory>
#include <mutex>

// this is the type of s t d :: c o u t
typedef std::basic_ostream<char, std::char_traits<char>> CoutType;

// this is the function signature of std::endl
typedef CoutType & (*StandardEndLine)(CoutType &);

class ConsoleStream
{
public:
  ConsoleStream(OutputWarehouse & output_warehouse);

  template <typename StreamType>
  const ConsoleStream & operator<<(const StreamType & s) const;

  const ConsoleStream & operator<<(const StandardEndLine & manip) const;

  void unsetf(std::ios_base::fmtflags mask) const;

  std::streampos tellp() const { return _oss->tellp(); }

  std::streamsize precision() const;

  std::streamsize precision(std::streamsize new_precision) const;

  std::ios_base::fmtflags flags() const;

  std::ios_base::fmtflags flags(std::ios_base::fmtflags new_flags) const;

  unsigned long long int numPrinted() const;

private:
  OutputWarehouse & _output_warehouse;

  mutable std::shared_ptr<std::ostringstream> _oss;

  static std::mutex _stream_mutex;
};

template <typename StreamType>
const ConsoleStream &
ConsoleStream::operator<<(const StreamType & s) const
{
  std::lock_guard<std::mutex> lock(_stream_mutex);

  (*_oss) << s;
  return *this;
}