XmLog.h

Go to the documentation of this file.

#pragma once
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//----- Included files ---------------------------------------------------------
// 1. Standard library headers

// 3. Standard Library Headers
#include <vector>

// 4. External Library Headers
#include <boost/function.hpp>
#include <boost/scoped_ptr.hpp>

// 5. Shared Headers
#include <xmscore/misc/Singleton.h>

// 6. Non-shared Headers

//----- Defines ----------------------------------------------------------------

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
#if _WIN32 || _WIN64 // WIN
// An odd ball string expansion requirement for the preprocessor
#define XM_UTIL2(line) UTIL##line
#define XM_UTIL(line) XM_UTIL2(line)
#define XM_LOG(A, B)                                      \
  ::xms::XmLog::Instance().Log(__FILE__, __LINE__, A, B); \
  \
static std::string XM_UTIL(__LINE__);                     \
  \
if(XM_UTIL(__LINE__).empty())                             \
  {                                                       \
    XM_UTIL(__LINE__) = xms::g_xmUtil;                    \
  \
}

namespace xms
{
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
extern std::string g_xmUtil;
}
#else // NOT WIN
#define XM_LOG(A, B) ::xms::XmLog::Instance().Log(__FILE__, __LINE__, A, B);
#endif // NOT WIN

//----- Forward declarations ---------------------------------------------------

//----- Namespace declaration --------------------------------------------------

//----- Constants / Enumerations -----------------------------------------------

// Define Severity Levels


namespace xmlog
{
enum MessageTypeEnum {
  info,    
  warning, 
  error,   
  debug    
};
/*
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
static std::string MessageTypeStr(MessageTypeEnum a_level) {
  if (a_level == info) return "INFO";
  if (a_level == warning) return "WARNING";
  if (a_level == error) return "ERROR";
  if (a_level == debug) return "DEBUG";
  return "";
} // MessageTypeStr
*/
}

namespace xms
{
typedef boost::function<std::string()> XmLogFilenameCallback;

typedef std::vector<std::pair<xmlog::MessageTypeEnum, std::string>> MessageStack;

//----- Structs / Classes ------------------------------------------------------

class XmLog : public xms::Singleton<XmLog>
{
  friend Singleton<XmLog>;

public:
  ~XmLog();
  void Log(const char* const a_file,
           int a_line,
           xmlog::MessageTypeEnum a_level,
           std::string a_message);
  int ErrCount();
  MessageStack GetAndClearStack();
  std::string GetAndClearStackStr();
  static XmLogFilenameCallback& LogFilenameCallback();
  static std::string LogFilename();

private:
  XmLog();
  struct Impl;
  boost::scoped_ptr<Impl> m;
}; // class XmLog

//----- Global functions -------------------------------------------------------

} // namespace xms