Dogcows Code - chaz/yoink/blob - src/Moof/Log.hh

   1
   2 /*******************************************************************************
   3
   4  Copyright (c) 2009, Charles McGarvey
   5  All rights reserved.
   6
   7  Redistribution   and   use  in  source  and  binary  forms,  with  or  without
   8  modification, are permitted provided that the following conditions are met:
   9
  10    * Redistributions  of  source  code  must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    * Redistributions  in binary form must reproduce the above copyright notice,
  13      this  list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15
  16  THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  20  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22  SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23  CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24  OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26
  27 *******************************************************************************/
  28
  29 #ifndef _MOOF_LOG_H_
  30 #define _MOOF_LOG_H_
  31
  32 /**
  33  * @file log.h
  34  * Functions related to logging the process.
  35  * The logging functions are logError(), logWarning(), logInfo(), and
  36  * logDebug(), listed from most critical to least critical.
  37  */
  38
  39 #include <cstdlib>              // exit
  40 #include <cstring>              // strerror
  41
  42
  43 /**
  44  * Macro which tests an assertion and issues an logError() and exits if false.
  45  * @param X test to perform
  46  */
  47
  48 #if ! NDEBUG
  49 #define ASSERT(X) if (!(X)) Mf::logError("false assertion at %s:%d, " #X, \
  50                 __FILE__, __LINE__), exit(1)
  51 #else
  52 #define ASSERT(X)
  53 #endif
  54
  55
  56 namespace Mf {
  57
  58
  59 /**
  60  * Possible values used for setting the log level using LogLevel().  Log
  61  * messages of lesser importance than the level specified are ignored.
  62  * @see LogLevel()
  63  */
  64
  65 enum LogLevel
  66 {
  67         LOG_NONE                = -1,           ///< Disable all logging.
  68         LOG_ERROR               =  1,           ///< Log only errors.
  69         LOG_WARNING             =  2,           ///< Log warnings and errors.
  70         LOG_INFO                =  3,           ///< Log info, warnings, errors.
  71         LOG_DEBUG               =  4            ///< Log all messages.
  72 };
  73
  74
  75 /**
  76  * Set and/or get the level of logs which will be logged.  If not called,
  77  * defaults to WARNING
  78  * @param level LOG_LEVEL_* constant or 0 for no change.
  79  * @return The currently set log level.
  80  */
  81
  82 LogLevel setLogLevel(LogLevel level);
  83
  84
  85 /**
  86  * Log an error.
  87  * @param fmt Log format string.
  88  * @param ... Extra format arguments.
  89  */
  90
  91 void logError(const char* fmt, ...);
  92
  93 /**
  94  * Log a warning.
  95  * @param fmt Log format string.
  96  * @param ... Extra format arguments.
  97  */
  98
  99 void logWarning(const char* fmt, ...);
 100
 101 /**
 102  * Log a message.
 103  * @param fmt Log format string.
 104  * @param ... Extra format arguments.
 105  */
 106
 107 void logInfo(const char* fmt, ...);
 108
 109 /**
 110  * Log a debug message.
 111  * @param fmt Log format string.
 112  * @param ... Extra format arguments.
 113  */
 114
 115 void logDebug(const char* fmt, ...);
 116
 117
 118 } // namespace Mf
 119
 120 #endif // _MOOF_LOG_H_
 121