// -*- C++ -*- // Module: Log4CPLUS // File: loglevel.h // Created: 6/2001 // Author: Tad E. Smith // // // Copyright 2001-2010 Tad E. Smith // // 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. /** @file * This header defines the LogLevel type. */ #ifndef LOG4CPLUS_LOGLEVEL_HEADER_ #define LOG4CPLUS_LOGLEVEL_HEADER_ #include #if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE) #pragma once #endif #include #include namespace log4cplus { /** * \typedef int LogLevel * Defines the minimum set of priorities recognized by the system, * that is {@link #FATAL_LOG_LEVEL}, {@link #ERROR_LOG_LEVEL}, {@link * #WARN_LOG_LEVEL}, {@link #INFO_LOG_LEVEL}, {@link #DEBUG_LOG_LEVEL}, * and {@link #TRACE_LOG_LEVEL}. */ typedef int LogLevel; /** \var const LogLevel OFF_LOG_LEVEL * The OFF_LOG_LEVEL LogLevel is used during configuration to * turn off logging. */ const LogLevel OFF_LOG_LEVEL = 60000; /** \var const LogLevel FATAL_LOG_LEVEL * The FATAL_LOG_LEVEL LogLevel designates very severe error * events that will presumably lead the application to abort. */ const LogLevel FATAL_LOG_LEVEL = 50000; /** \var const LogLevel ERROR_LOG_LEVEL * The ERROR_LOG_LEVEL LogLevel designates error events that * might still allow the application to continue running. */ const LogLevel ERROR_LOG_LEVEL = 40000; /** \var const LogLevel WARN_LOG_LEVEL * The WARN_LOG_LEVEL LogLevel designates potentially harmful * situations. */ const LogLevel WARN_LOG_LEVEL = 30000; /** \var const LogLevel INFO_LOG_LEVEL * The INFO_LOG_LEVEL LogLevel designates informational * messages that highlight the progress of the application at * coarse-grained level. */ const LogLevel INFO_LOG_LEVEL = 20000; /** \var const LogLevel DEBUG_LOG_LEVEL * The DEBUG_LOG_LEVEL LogLevel designates fine-grained * informational events that are most useful to debug an application. */ const LogLevel DEBUG_LOG_LEVEL = 10000; /** \var const LogLevel TRACE_LOG_LEVEL * The TRACE_LOG_LEVEL LogLevel is used to "trace" entry * and exiting of methods. */ const LogLevel TRACE_LOG_LEVEL = 0; /** \var const LogLevel ALL_LOG_LEVEL * The ALL_LOG_LEVEL LogLevel is used during configuration to * turn on all logging. */ const LogLevel ALL_LOG_LEVEL = TRACE_LOG_LEVEL; /** \var const LogLevel NOT_SET_LOG_LEVEL * The NOT_SET_LOG_LEVEL LogLevel is used to indicated that * no particular LogLevel is desired and that the default should be used. */ const LogLevel NOT_SET_LOG_LEVEL = -1; /** * This method type defined the signature of methods that convert LogLevels * into strings. * * Note: Must return an empty tstring for unrecognized values. */ typedef log4cplus::tstring const & (*LogLevelToStringMethod)(LogLevel); //! This function type is for log4cplus 1.0.x callbacks. typedef log4cplus::tstring (*LogLevelToStringMethod_1_0) (LogLevel); /** * This method type defined the signature of methods that convert strings * into LogLevels. * * Note: Must return NOT_SET_LOG_LEVEL for unrecognized values. */ typedef LogLevel (*StringToLogLevelMethod)(const log4cplus::tstring&); /** * This class is used to "manage" LogLevel definitions. This class is also * how "derived" LogLevels are created. Here are the steps to creating a * "derived" LogLevel: *
    *
  1. Create a LogLevel constant (greater than 0)
    2. *
  2. Define a string to represent that constant
    3. *
  3. Implement a LogLevelToStringMethod method.
    4. *
  4. Implement a StringToLogLevelMethod method.
    5. *
  5. create a "static initializer" that registers those 2 methods * with the LogLevelManager singleton.
    6. *
*/ class LOG4CPLUS_EXPORT LogLevelManager { public: LogLevelManager(); ~LogLevelManager(); /** * This method is called by all Layout classes to convert a LogLevel * into a string. * * Note: It traverses the list of LogLevelToStringMethod * to do this, so all "derived" LogLevels are recognized as well. */ log4cplus::tstring const & toString(LogLevel ll) const; /** * This method is called by all classes internally to log4cplus to * convert a string into a LogLevel. * * Note: It traverses the list of StringToLogLevelMethod * to do this, so all "derived" LogLevels are recognized as well. */ LogLevel fromString(const log4cplus::tstring& s) const; /** * When creating a "derived" LogLevel, a LogLevelToStringMethod * should be defined and registered with the LogLevelManager by calling * this method. * * @see pushFromStringMethod */ void pushToStringMethod(LogLevelToStringMethod newToString); //! For compatibility with log4cplus 1.0.x. void pushToStringMethod(LogLevelToStringMethod_1_0 newToString); /** * When creating a "derived" LogLevel, a StringToLogLevelMethod * should be defined and registered with the LogLevelManager by calling * this method. * * @see pushToStringMethod */ void pushFromStringMethod(StringToLogLevelMethod newFromString); private: // Data struct LogLevelToStringMethodRec { union { LogLevelToStringMethod func; LogLevelToStringMethod_1_0 func_1_0; }; bool use_1_0; }; typedef std::vector LogLevelToStringMethodList; LogLevelToStringMethodList toStringMethods; typedef std::vector StringToLogLevelMethodList; StringToLogLevelMethodList fromStringMethods; // Disable Copy LogLevelManager(const LogLevelManager&); LogLevelManager& operator=(const LogLevelManager&); }; /** * Returns the singleton LogLevelManager. */ LOG4CPLUS_EXPORT LogLevelManager& getLogLevelManager(); } #endif // LOG4CPLUS_LOGLEVEL_HEADER_