Console.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012 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 _GAZEBO_CONSOLE_HH_
#define _GAZEBO_CONSOLE_HH_

#include <iostream>
#include <fstream>
#include <sstream>
#include <string>

#ifndef Q_MOC_RUN  // See: https://bugreports.qt-project.org/browse/QTBUG-22829
# include <boost/thread.hpp>
#endif
#include "gazebo/common/SingletonT.hh"
#include "gazebo/common/CommonTypes.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace common
  {

    #define gzmsg (gazebo::common::Console::msg())

    #define gzdbg (gazebo::common::Console::dbg(__FILE__, __LINE__))

    #define gzwarn (gazebo::common::Console::warn(__FILE__, __LINE__))

    #define gzerr (gazebo::common::Console::err(__FILE__, __LINE__))

    #define gzlog (gazebo::common::Console::log())

    #define gzLogInit(_prefix, _str) \
        (gazebo::common::Console::log.Init(_prefix, _str))

    #define gzLogDirectory() (gazebo::common::Console::log.GetLogDirectory())

    class GZ_COMMON_VISIBLE FileLogger : public std::ostream
    {
      public: explicit FileLogger(const std::string &_filename = "");

      public: virtual ~FileLogger();

      public: void Init(const std::string &_prefix,
                        const std::string &_filename);

      public: virtual FileLogger &operator()();

      public: virtual FileLogger &operator()(
                  const std::string &_file, int _line);

      public: std::string GetLogDirectory() const;

      private: static std::string GetMasterPort();

      protected: class Buffer : public std::stringbuf
                 {
                   public: explicit Buffer(const std::string &_filename);

                   public: virtual ~Buffer();

                   public: virtual int sync();

                   public: std::ofstream *stream;
                 };

      private: std::string logDirectory;
    };

    class GZ_COMMON_VISIBLE Logger : public std::ostream
    {
      public: enum LogType
              {
                STDOUT,
                STDERR
              };

      public: Logger(const std::string &_prefix, int _color, LogType _type);

      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, int _color);

                   public: virtual ~Buffer();

                   public: virtual int sync();

                   public: LogType type;

                   public: int color;
                 };

      public: int color;

      private: std::string prefix;
    };

    class GZ_COMMON_VISIBLE Console
    {
      public: static void SetQuiet(bool _q);

      public: static bool GetQuiet();

      public: static Logger msg;

      public: static Logger err;

      public: static Logger dbg;

      public: static Logger warn;

      public: static FileLogger log;

      private: static bool quiet;
    };
  }
}
#endif