gz/common/Console.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * 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 GZ_COMMON_CONSOLE_HH_
#define GZ_COMMON_CONSOLE_HH_
 
#include <iostream>
#include <fstream>
#include <memory>
#include <mutex>
#include <sstream>
#include <string>
 
#include <gz/common/Export.hh>
#include <gz/utils/SuppressWarning.hh>
#include <gz/common/Util.hh>
 
namespace gz
{
  namespace common
  {
    // TODO(CH3): Deprecated. Remove all the ign macros on tock.
    #define gzerr  (gz::common::Console::err(__FILE__, __LINE__))
    #define ignerr gzerr
 
    #define gzwarn  (gz::common::Console::warn(__FILE__, __LINE__))
    #define ignwarn gzwarn
 
    #define gzmsg  (gz::common::Console::msg())
    #define ignmsg gzmsg
 
    #define gzdbg  (gz::common::Console::dbg(__FILE__, __LINE__))
    #define igndbg gzdbg
 
    #define gzlog  (gz::common::Console::log())
    #define ignlog gzlog
 
    #define gzLogInit(_dir, _file)\
        gz::common::Console::log.Init(_dir, _file)
    #define ignLogInit(_dir, _file) gzLogInit(_dir, _file)
 
    #define gzLogClose()\
        gz::common::Console::log.Close()
    #define ignLogClose() gzLogClose()
 
    #define gzLogDirectory()\
        (gz::common::Console::log.LogDirectory())
    #define ignLogDirectory() gzLogDirectory()
 
    class GZ_COMMON_VISIBLE FileLogger : public std::ostream
    {
      public: explicit FileLogger(const std::string &_filename = "");
 
      public: virtual ~FileLogger();
 
      public: void Init(const std::string &_directory,
                        const std::string &_filename);
 
      public: void Close();
 
      public: virtual FileLogger &operator()();
 
      public: virtual FileLogger &operator()(
                  const std::string &_file, int _line);
 
      public: std::string LogDirectory() const;
 
      protected: class Buffer : public std::stringbuf
                 {
                   public: explicit Buffer(const std::string &_filename);
 
                   public: virtual ~Buffer();
 
                   public: std::streamsize xsputn(
                        const char *_char, std::streamsize _count) override;
 
                   public: int sync() override;
 
                   public: std::ofstream *stream;
 
                   public: std::mutex syncMutex;
                 };
 
      GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::string logDirectory;
      GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
 
      private: bool initialized;
    };
 
    class GZ_COMMON_VISIBLE Logger : public std::ostream
    {
      public: enum LogType
              {
                STDOUT,
                STDERR
              };
 
      public: Logger(const std::string &_prefix, const int _color,
                     const LogType _type, const int _verbosity);
 
      public: virtual ~Logger();
 
      public: virtual Logger &operator()();
 
      public: virtual Logger &operator()(
                  const std::string &_file, int _line);
 
      protected: class Buffer : public std::stringbuf
                 {
                   public: Buffer(LogType _type, const int _color,
                                  const int _verbosity);
 
                   public: virtual ~Buffer();
 
                   public: std::streamsize xsputn(
                        const char *_char, std::streamsize _count) override;
 
                   public: int sync() override;
 
                   public: LogType type;
 
                   public: int color;
 
                   public: int verbosity;
 
                   public: std::mutex syncMutex;
                 };
 
      GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::string prefix;
      GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
    };
 
    class GZ_COMMON_VISIBLE Console
    {
      public: static void SetVerbosity(const int _level);
 
      public: static int Verbosity();
 
      public: static void SetPrefix(const std::string &_customPrefix);
 
      public: static std::string Prefix();
 
      public: static Logger msg;
 
      public: static Logger err;
 
      public: static Logger dbg;
 
      public: static Logger warn;
 
      public: static FileLogger log;
 
      private: static int verbosity;
 
      GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: static std::string customPrefix;
      GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
#endif