Logger.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_LOGGER_HPP_INCLUDE_GUARD_
#define BLOCXX_LOGGER_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/String.hpp"
#include "blocxx/LogLevel.hpp"
#include "blocxx/IntrusiveCountableBase.hpp"
#include "blocxx/Exception.hpp"
#include "blocxx/LogAppender.hpp"
#include "blocxx/GlobalString.hpp"
#include <cerrno>


namespace BLOCXX_NAMESPACE
{

BLOCXX_DECLARE_APIEXCEPTION(Logger, BLOCXX_COMMON_API)



class BLOCXX_COMMON_API Logger : public IntrusiveCountableBase
{
public:

   static const GlobalString STR_NONE_CATEGORY;
   static const GlobalString STR_FATAL_CATEGORY;
   static const GlobalString STR_ERROR_CATEGORY;
   static const GlobalString STR_WARNING_CATEGORY;
   static const GlobalString STR_INFO_CATEGORY;
   static const GlobalString STR_DEBUG_CATEGORY;
   static const GlobalString STR_DEBUG2_CATEGORY;
   static const GlobalString STR_DEBUG3_CATEGORY;
   static const GlobalString STR_ALL_CATEGORY;
   static const GlobalString STR_DEFAULT_COMPONENT; // "none"

   enum ELoggerErrorCodes
   {
      E_UNKNOWN_LOG_APPENDER_TYPE,
      E_INVALID_MAX_FILE_SIZE,
      E_INVALID_MAX_BACKUP_INDEX
   };

   Logger(const String& defaultComponent = STR_DEFAULT_COMPONENT, const LogAppenderRef& appender = LogAppenderRef());

   Logger(const String& defaultComponent, const ELogLevel logLevel);

   Logger(const Logger&);
   Logger& operator=(const Logger&);
   void swap(Logger& x);
   virtual ~Logger();

   virtual LoggerRef clone() const BLOCXX_DEPRECATED; // in 4.0.0
   
   void logFatalError(const String& message, const char* filename = 0, int fileline = -1, const char* methodname = 0) const;
   
   void logError(const String& message, const char* filename = 0, int fileline = -1, const char* methodname = 0) const;
   
   void logWarning(const String& message, const char* filename = 0, int fileline = -1, const char* methodname = 0) const;
   
   void logInfo(const String& message, const char* filename = 0, int fileline = -1, const char* methodname = 0) const;
   
   void logDebug(const String& message, const char* filename = 0, int fileline = -1, const char* methodname = 0) const;

   void logDebug2(const String& message, const char* filename = 0, int fileline = -1, const char* methodname = 0) const;

   void logDebug3(const String& message, const char* filename = 0, int fileline = -1, const char* methodname = 0) const;

   // Note that we don't use defaults on logMessage so the correct overload will be chosen.
   void logMessage(const String& component, const String& category, const String& message) const;
   void logMessage(const String& component, const String& category, const String& message, const char* filename, int fileline, const char* methodname) const;

   void logMessage(const String& category, const String& message) const;
   
   void logMessage(const String& category, const String& message, const char* filename, int fileline, const char* methodname) const;

   void logMessage(const LogMessage& message) const;

   void setDefaultComponent(const String& component);

   String getDefaultComponent() const;

   ELogLevel getLogLevel() const
   {
      return m_logLevel;
   }

   void setLogLevel(ELogLevel logLevel);

   void setLogLevel(const String& logLevel);

   static ELogLevel stringToLogLevel(const String& logLevel);
   
   static String logLevelToString(ELogLevel logLevel);

   bool categoryIsEnabled(const String& category) const;

   bool levelIsEnabled(const ELogLevel level) const;

   bool componentAndCategoryAreEnabled(const String& component, const String& category) const;

   static inline const Logger& asLogger(const Logger& lgr)
   {
      return lgr;
   }
   static inline const Logger& asLogger(const LoggerRef& lgr)
   {
      return *lgr;
   }

private:
   void processLogMessage(const LogMessage& message) const;

protected: // data
   String m_defaultComponent;
   LogAppenderRef m_appender;
   ELogLevel m_logLevel;
};
BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, IntrusiveReference, Logger);

} // end namespace BLOCXX_NAMESPACE


#if defined(BLOCXX_HAVE_UUPRETTY_FUNCTIONUU)
#define BLOCXX_LOGGER_PRETTY_FUNCTION __PRETTY_FUNCTION__
#elif defined(BLOCXX_HAVE_C99_UUFUNCUU)
#define BLOCXX_LOGGER_PRETTY_FUNCTION __func__
#else
#define BLOCXX_LOGGER_PRETTY_FUNCTION ""
#endif

#define BLOCXX_LOG_DEBUG3(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_DEBUG3_LEVEL) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_DEBUG3_CATEGORY, (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)


#define BLOCXX_LOG_DEBUG2(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_DEBUG2_LEVEL) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_DEBUG2_CATEGORY, (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)


#define BLOCXX_LOG_DEBUG(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_DEBUG_LEVEL) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_DEBUG_CATEGORY, (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)


#define BLOCXX_LOG_INFO(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_INFO_LEVEL) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_INFO_CATEGORY, (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_LOG_WARNING(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_WARNING_LEVEL) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_WARNING_CATEGORY, (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_LOG_ERROR(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_ERROR_LEVEL) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_ERROR_CATEGORY, (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_LOG_FATAL_ERROR(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_FATAL_ERROR_LEVEL) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_FATAL_CATEGORY, (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_LOG(logger, category, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).categoryIsEnabled((category))) \
   { \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage((category), (message), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG_DEBUG3(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_DEBUG3_LEVEL) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_DEBUG3_CATEGORY, buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG_DEBUG2(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_DEBUG2_LEVEL) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_DEBUG2_CATEGORY, buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG_DEBUG(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_DEBUG_LEVEL) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_DEBUG_CATEGORY, buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG_INFO(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_INFO_LEVEL) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_INFO_CATEGORY, buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG_WARNING(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_WARNING_LEVEL) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_WARNING_CATEGORY, buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG_ERROR(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_ERROR_LEVEL) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_ERROR_CATEGORY, buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG_FATAL_ERROR(logger, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).getLogLevel() >= ::BLOCXX_NAMESPACE::E_FATAL_ERROR_LEVEL) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage(::BLOCXX_NAMESPACE::Logger::STR_FATAL_CATEGORY, buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#define BLOCXX_SLOG(logger, category, message) \
do \
{ \
   int err = errno; \
   if (::BLOCXX_NAMESPACE::Logger::asLogger((logger)).categoryIsEnabled((category))) \
   { \
      OStringStream buf; \
      buf << message; \
      ::BLOCXX_NAMESPACE::Logger::asLogger((logger)).logMessage((category), buf.toString(), __FILE__, __LINE__, BLOCXX_LOGGER_PRETTY_FUNCTION); \
   } \
   errno = err; \
} while (0)

#endif   // BLOCXX_LOGGER_HPP_INCLUDE_GUARD_