Console.hh

Go to the documentation of this file.

/*
 * Copyright 2011 Nate Koenig
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef SDF_CONSOLE_HH_
#define SDF_CONSOLE_HH_

#include <fstream>
#include <iostream>
#include <memory>
#include <string>

#include <sdf/sdf_config.h>
#include "sdf/system_util.hh"

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif

namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //


  #define sdfdbg (sdf::Console::Instance()->Log("Dbg", __FILE__, __LINE__))

  #define sdfmsg (sdf::Console::Instance()->ColorMsg("Msg", \
                                                     __FILE__, __LINE__, 32))

  #define sdfwarn (sdf::Console::Instance()->ColorMsg("Warning", \
                                                      __FILE__, __LINE__, 33))

  #define sdferr (sdf::Console::Instance()->ColorMsg("Error", \
                                                     __FILE__, __LINE__, 31))

  class ConsolePrivate;
  class Console;

  typedef std::shared_ptr<Console> ConsolePtr;

  class SDFORMAT_VISIBLE Console
  {
    public: class SDFORMAT_VISIBLE ConsoleStream
    {
      public: ConsoleStream(std::ostream *_stream) :
              stream(_stream) {}

      public: template <class T>
        ConsoleStream &operator<<(const T &_rhs);

      public: void Prefix(const std::string &_lbl,
                          const std::string &_file,
                          unsigned int _line, int _color);

      private: std::ostream *stream;
    };

    private: Console();

    public: virtual ~Console();

    public: static ConsolePtr Instance();

    public: static void Clear();

    public: void SetQuiet(bool _q);

    public: ConsoleStream &ColorMsg(const std::string &lbl,
                                    const std::string &file,
                                    unsigned int line, int color);

    public: ConsoleStream &Log(const std::string &lbl,
                               const std::string &file,
                               unsigned int line);

    private: std::unique_ptr<ConsolePrivate> dataPtr;
  };

  class ConsolePrivate
  {
    public: ConsolePrivate() : msgStream(&std::cerr), logStream(nullptr) {}

    public: Console::ConsoleStream msgStream;

    public: Console::ConsoleStream logStream;

    public: std::ofstream logFileStream;
  };

  template <class T>
  Console::ConsoleStream &Console::ConsoleStream::operator<<(const T &_rhs)
  {
    if (this->stream)
    {
      *this->stream << _rhs;
    }

    if (Console::Instance()->dataPtr->logFileStream.is_open())
    {
      Console::Instance()->dataPtr->logFileStream << _rhs;
      Console::Instance()->dataPtr->logFileStream.flush();
    }

    return *this;
  }
  }

}

#ifdef _WIN32
#pragma warning(pop)
#endif

#endif