src/shared/Log.h

   1 /*
   2  * Copyright (C) 2005,2006,2007 MaNGOS <http://www.mangosproject.org/>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef MANGOSSERVER_LOG_H
  20 #define MANGOSSERVER_LOG_H
  21
  22 #include "Common.h"
  23 #include "Policies/Singleton.h"
  24
  25 class Config;
  26
  27 // bitmask
  28 enum LogFilters
  29 {
  30     LOG_FILTER_TRANSPORT_MOVES    = 1,
  31     LOG_FILTER_CREATURE_MOVES     = 2,
  32     LOG_FILTER_VISIBILITY_CHANGES = 4
  33 };
  34
  35 enum Color
  36 {
  37     BLACK,
  38     RED,
  39     GREEN,
  40     BROWN,
  41     BLUE,
  42     MAGENTA,
  43     CYAN,
  44     GREY,
  45     YELLOW,
  46     LRED,
  47     LGREEN,
  48     LBLUE,
  49     LMAGENTA,
  50     LCYAN,
  51     WHITE
  52 };
  53
  54 const int Color_count = int(WHITE)+1;
  55
  56 class Log : public MaNGOS::Singleton<Log, MaNGOS::ClassLevelLockable<Log, ZThread::FastMutex> >
  57 {
  58     friend class MaNGOS::OperatorNew<Log>;
  59     Log() : raLogfile(NULL), logfile(NULL), gmLogfile(NULL), dberLogfile(NULL), m_colored(false) { Initialize(); }
  60     ~Log()
  61     {
  62         if( logfile != NULL )
  63             fclose(logfile);
  64         logfile = NULL;
  65
  66         if( gmLogfile != NULL )
  67             fclose(gmLogfile);
  68         gmLogfile = NULL;
  69
  70         if( dberLogfile != NULL )
  71             fclose(dberLogfile);
  72         dberLogfile = NULL;
  73
  74         if (raLogfile != NULL)
  75             fclose(raLogfile);
  76         raLogfile = NULL;
  77     }
  78     public:
  79         void Initialize();
  80         void InitColors(std::string init_str);
  81         void outTitle( const char * str);
  82         void outCommand( const char * str, ...)      ATTR_PRINTF(2,3);
  83         void outString();                                   // any log level
  84                                                             // any log level
  85         void outString( const char * str, ... )      ATTR_PRINTF(2,3);
  86                                                             // any log level
  87         void outError( const char * err, ... )       ATTR_PRINTF(2,3);
  88                                                             // log level >= 1
  89         void outBasic( const char * str, ... )       ATTR_PRINTF(2,3);
  90                                                             // log level >= 2
  91         void outDetail( const char * str, ... )      ATTR_PRINTF(2,3);
  92                                                             // log level >= 3
  93         void outDebugInLine( const char * str, ... ) ATTR_PRINTF(2,3);
  94                                                             // log level >= 3
  95         void outDebug( const char * str, ... )       ATTR_PRINTF(2,3);
  96                                                             // any log level
  97         void outMenu( const char * str, ... )        ATTR_PRINTF(2,3);
  98                                                             // any log level
  99         void outErrorDb( const char * str, ... )     ATTR_PRINTF(2,3);
 100                                                             // any log level
 101         void outRALog( const char * str, ... )       ATTR_PRINTF(2,3);
 102         void SetLogLevel(char * Level);
 103         void SetLogFileLevel(char * Level);
 104         void SetColor(bool stdout_stream, Color color);
 105         void ResetColor(bool stdout_stream);
 106         void outTimestamp(FILE* file);
 107         std::string GetTimestampStr() const;
 108         uint32 getLogFilter() const { return m_logFilter; }
 109         bool IsOutDebug() const { return m_logLevel > 2 || m_logFileLevel > 2 && logfile; }
 110     private:
 111         FILE* raLogfile;
 112         FILE* logfile;
 113         FILE* gmLogfile;
 114         FILE* dberLogfile;
 115
 116         uint32 m_logLevel;
 117         uint32 m_logFileLevel;
 118         bool m_colored;
 119         Color m_colors[4];
 120         uint32 m_logFilter;
 121 };
 122
 123 #define sLog MaNGOS::Singleton<Log>::Instance()
 124
 125 #ifdef MANGOS_DEBUG
 126 #define DEBUG_LOG MaNGOS::Singleton<Log>::Instance().outDebug
 127 #else
 128 #define DEBUG_LOG
 129 #endif
 130
 131 // primary for script library
 132 void MANGOS_DLL_SPEC debug_log(const char * str, ...) ATTR_PRINTF(1,2);
 133 void MANGOS_DLL_SPEC error_log(const char * str, ...) ATTR_PRINTF(1,2);
 134 #endif