OW_Logger.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, 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 the names of its
*    contributors 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 Vintela, Inc. OR THE 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 OW_LOGGER_HPP_INCLUDE_GUARD_
#define OW_LOGGER_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_CommonFwd.hpp"
#include "OW_String.hpp"
#include "OW_LogLevel.hpp"
#include "OW_IntrusiveCountableBase.hpp"
#include "OW_Exception.hpp"

namespace OW_NAMESPACE
{

OW_DECLARE_APIEXCEPTION(Logger, OW_COMMON_API)



class OW_COMMON_API Logger : public IntrusiveCountableBase
{
public:

   static const String STR_NONE_CATEGORY;
   static const String STR_FATAL_CATEGORY;
   static const String STR_ERROR_CATEGORY;
   static const String STR_INFO_CATEGORY;
   static const String STR_DEBUG_CATEGORY;
   static const String STR_ALL_CATEGORY;
   static const String STR_DEFAULT_COMPONENT; // "none"

   enum ELoggerErrorCodes
   {
      E_UNKNOWN_LOG_APPENDER_TYPE,
      E_INVALID_MAX_FILE_SIZE,
      E_INVALID_MAX_BACKUP_INDEX
   };

   static LoggerRef getCurrentLogger();

   static LoggerRef getDefaultLogger();

   static bool setDefaultLogger(const LoggerRef &ref);

   static bool setThreadLogger(const LoggerRef &ref);

   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 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;

   // 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);

   bool categoryIsEnabled(const String& category) const;

   bool levelIsEnabled(const ELogLevel level);

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

   LoggerRef clone() const;

   static LoggerRef createLogger( const String& type,
      bool debug ) OW_DEPRECATED;   // in 3.1.0

   virtual ~Logger();

protected:
   Logger() OW_DEPRECATED; // in 3.1.0
   Logger(const ELogLevel l) OW_DEPRECATED; // in 3.1.0

   // Derived class interface

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

   virtual void doProcessLogMessage(const LogMessage& message) const = 0;

   virtual bool doCategoryIsEnabled(const String& category) const;
   
   virtual bool doComponentAndCategoryAreEnabled(const String& component, const String& category) const;

   virtual LoggerRef doClone() const = 0;

protected:
   Logger(const Logger&);
   Logger& operator=(const Logger&);
   void swap(Logger& x);

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

private: // data
   ELogLevel m_logLevel;
   String m_defaultComponent;
};
OW_EXPORT_TEMPLATE(OW_COMMON_API, IntrusiveReference, Logger);

} // end namespace OW_NAMESPACE


#if defined(OW_HAVE_UUPRETTY_FUNCTIONUU)
#define OW_LOGGER_PRETTY_FUNCTION __PRETTY_FUNCTION__
#elif defined(OW_HAVE_C99_UUFUNCUU)
#define OW_LOGGER_PRETTY_FUNCTION __func__
#else
#define OW_LOGGER_PRETTY_FUNCTION ""
#endif

#define OW_LOG_DEBUG(logger, message) \
do \
{ \
   if ((logger)->getLogLevel() >= ::OW_NAMESPACE::E_DEBUG_LEVEL) \
   { \
      (logger)->logMessage(::OW_NAMESPACE::Logger::STR_DEBUG_CATEGORY, (message), __FILE__, __LINE__, OW_LOGGER_PRETTY_FUNCTION); \
   } \
} while (0)

#define OW_LOG_INFO(logger, message) \
do \
{ \
   if ((logger)->getLogLevel() >= ::OW_NAMESPACE::E_INFO_LEVEL) \
   { \
      (logger)->logMessage(::OW_NAMESPACE::Logger::STR_INFO_CATEGORY, (message), __FILE__, __LINE__, OW_LOGGER_PRETTY_FUNCTION); \
   } \
} while (0)

#define OW_LOG_ERROR(logger, message) \
do \
{ \
   if ((logger)->getLogLevel() >= ::OW_NAMESPACE::E_ERROR_LEVEL) \
   { \
      (logger)->logMessage(::OW_NAMESPACE::Logger::STR_ERROR_CATEGORY, (message), __FILE__, __LINE__, OW_LOGGER_PRETTY_FUNCTION); \
   } \
} while (0)

#define OW_LOG_FATAL_ERROR(logger, message) \
do \
{ \
   if ((logger)->getLogLevel() >= ::OW_NAMESPACE::E_FATAL_ERROR_LEVEL) \
   { \
      (logger)->logMessage(::OW_NAMESPACE::Logger::STR_FATAL_CATEGORY, (message), __FILE__, __LINE__, OW_LOGGER_PRETTY_FUNCTION); \
   } \
} while (0)

#define OW_LOG(logger, category, message) \
do \
{ \
   if ((logger)->categoryIsEnabled((category))) \
   { \
      (logger)->logMessage((category), (message), __FILE__, __LINE__, OW_LOGGER_PRETTY_FUNCTION); \
   } \
} while (0)



#endif

---