src/log.h

   1 /*********************************
   2 ** Tsunagari Tile Engine        **
   3 ** log.h                        **
   4 ** Copyright 2011-2012 OmegaSDG **
   5 *********************************/
   6
   7 // **********
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to
  10 // deal in the Software without restriction, including without limitation the
  11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  12 // sell copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  24 // IN THE SOFTWARE.
  25 // **********
  26
  27 #ifndef LOG_H
  28 #define LOG_H
  29
  30 #include <boost/utility.hpp> // for boost::noncopyable
  31 #include <string>
  32
  33 enum verbosity_t {
  34         V_QUIET = 1,   //! Display fatals.
  35         V_NORMAL,  //! Display fatals and errors.
  36         V_VERBOSE  //! Display fatals, errors and info.
  37 };
  38
  39 class Log : boost::noncopyable
  40 {
  41 public:
  42         /**
  43          * Initialize the clock for log timestamps.
  44          */
  45         static bool init();
  46
  47         /**
  48          * Set the logging verbosity. Some log messages may be suppressed depending
  49          * on this setting.
  50          */
  51         static void setVerbosity(verbosity_t mode);
  52
  53         /**
  54          * Log an info message to the console if verbosity is "V_VERBOSE".
  55          */
  56         static void info(std::string domain, std::string msg);
  57
  58         /**
  59          * Log an error message to the console if verbosity is "V_VERBOSE" or
  60          * "V_NORMAL".
  61          */
  62         static void err(std::string domain, std::string msg);
  63
  64         /**
  65          * Log a fatal error message to the console.
  66          */
  67         static void fatal(std::string domain, std::string msg);
  68
  69         /**
  70          * Used by main() to report the verbosity setting on engine startup.
  71          */
  72         static void reportVerbosityOnStartup();
  73
  74 private:
  75         Log();
  76 };
  77
  78 /**
  79  * Exports Log hooks to the python interpreter.
  80  */
  81 void exportLog();
  82
  83 #endif
  84