src/log.h

   1 /***************************************
   2 ** Tsunagari Tile Engine              **
   3 ** log.h                              **
   4 ** Copyright 2011-2013 PariahSoft LLC **
   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 <string>
  31
  32 enum verbosity_t {
  33         V_QUIET = 1,   //! Display fatals.
  34         V_NORMAL,  //! Display fatals and errors.
  35         V_VERBOSE  //! Display fatals, errors and info.
  36 };
  37
  38 class Log
  39 {
  40 public:
  41         /**
  42          * Initialize the clock for log timestamps.
  43          */
  44         static bool init();
  45
  46         /**
  47          * Set the logging verbosity. Some log messages may be suppressed depending
  48          * on this setting.
  49          */
  50         static void setVerbosity(verbosity_t mode);
  51
  52         /**
  53          * Log an info message to the console if verbosity is "V_VERBOSE".
  54          */
  55         static void info(std::string domain, std::string msg);
  56
  57         /**
  58          * Log an error message to the console if verbosity is "V_VERBOSE" or
  59          * "V_NORMAL".
  60          */
  61         static void err(std::string domain, std::string msg);
  62
  63         /**
  64          * Log a fatal error message to the console.
  65          */
  66         static void fatal(std::string domain, std::string msg);
  67
  68         /**
  69          * Used by main() to report the verbosity setting on engine startup.
  70          */
  71         static void reportVerbosityOnStartup();
  72
  73 private:
  74         Log();
  75         Log(const Log&) = delete;
  76         Log(Log&&) = delete;
  77         Log& operator=(const Log&) = delete;
  78         Log& operator=(Log&&) = delete;
  79 };
  80
  81 /**
  82  * Exports Log hooks to the python interpreter.
  83  */
  84 void exportLog();
  85
  86 #endif
  87