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 <iostream>
  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 #undef ASSERT
  49
  50 #if NDEBUG
  51 #define ASSERT(X)
  52 #else
  53 #define ASSERT(X) if (!(X)) Mf::logError << \
  54         "false assertion at " << __FILE__ << ":" << __LINE__ << ", " << #X, exit(1)
  55 #endif
  56
  57
  58 namespace Mf {
  59
  60
  61 class Log
  62 {
  63 public:
  64
  65         enum Level
  66         {
  67                 NONE            = 0,            ///< Disable all logging.
  68                 ERRORR          = 1,            ///< Log only errors.
  69                 WARNING         = 2,            ///< Log warnings and errors.
  70                 INFO            = 3,            ///< Log everything.
  71         };
  72
  73         static void setLevel(Level level);
  74         static Level getLevel();
  75
  76
  77         Log(Level level, const char* type) :
  78                 mLevel(level),
  79                 mType(type) /* only pass literal strings */ {}
  80
  81
  82         template <typename T>
  83         void operator () (const T& item)
  84         {
  85                 *this << item << std::endl;
  86         }
  87
  88 private:
  89
  90         template <typename T> friend std::ostream& operator << (Log&, const T&);
  91
  92         static Level    gLevel;
  93
  94         Level                   mLevel;
  95         const char*             mType;
  96 };
  97
  98
  99 extern std::ostream&    log;
 100 extern std::ostream&    nullLog;
 101
 102 extern Log logError;
 103 extern Log logWarning;
 104 extern Log logInfo;
 105
 106
 107 template <typename T>
 108 inline std::ostream& operator << (Log& logObj, const T& item)
 109 {
 110         if (Log::gLevel < logObj.mLevel) return nullLog;
 111         return log << logObj.mType << item;
 112 }
 113
 114
 115 class Script;
 116 void importLogFunctions(Script& script);
 117
 118
 119 } // namespace Mf
 120
 121 #endif // _MOOF_LOG_H_
 122