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 <spdlog/logger.h>
#include <spdlog/spdlog.h>
 
#include <fstream>
#include <iostream>
#include <ostream>
#include <sstream>
#include <string>
 
#include <gz/common/Export.hh>
#include <gz/common/Util.hh>
#include <gz/utils/log/Logger.hh>
#include <gz/utils/SuppressWarning.hh>
 
namespace gz
{
  namespace common
  {
    class GZ_COMMON_VISIBLE LogMessage
    {
      public: LogMessage(const char *_file,
                         int _line,
                         spdlog::level::level_enum _logLevel);
 
      public: ~LogMessage();
 
      public: std::ostream &stream();
 
      private: spdlog::level::level_enum severity;
 
      private: spdlog::source_loc sourceLocation;
 
      private: std::ostringstream ss;
    };
 
    #define gzcrit (gz::common::LogMessage( \
      __FILE__, __LINE__, spdlog::level::critical).stream())
 
    #define gzerr gz::common::LogMessage( \
      __FILE__, __LINE__, spdlog::level::err).stream()
 
    #define gzwarn gz::common::LogMessage( \
      __FILE__, __LINE__, spdlog::level::warn).stream()
 
    #define gzlog gz::common::LogMessage( \
      __FILE__, __LINE__, spdlog::level::trace).stream()
 
    #define gzmsg gz::common::LogMessage( \
      __FILE__, __LINE__, spdlog::level::info).stream()
 
    #define gzdbg gz::common::LogMessage( \
      __FILE__, __LINE__, spdlog::level::debug).stream()
 
    #define gztrace gz::common::LogMessage( \
      __FILE__, __LINE__, spdlog::level::trace).stream()
 
    #define gzLogInit(_dir, _file)\
      gz::common::Console::Init(_dir, _file)
 
    #define gzLogClose()\
      gz::common::Console::Close()
 
    #define gzLogDirectory()\
      (gz::common::Console::Directory())
 
    class GZ_COMMON_VISIBLE Console : public gz::utils::log::Logger
    {
      public: explicit Console(const std::string &_loggerName);
 
      public: static Console &Root();
 
      public: static bool Init(const std::string &_directory,
                               const std::string &_filename);
     
      public: static void Close();
      
      public: static std::string Directory();
 
      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 bool initialized;
 
      private: static int verbosity;
 
      GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: static std::string customPrefix;
 
      private: std::string logDirectory;
      GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
#endif