log.h

   1 /*
   2     Copyright 2004-2005 Chris Tallon
   3     Copyright 2003-2004 University Of Bradford
   4
   5     This file is part of VOMP.
   6
   7     VOMP is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     VOMP is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with VOMP; if not, write to the Free Software
  19     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20 */
  21
  22 #ifndef LOG_H
  23 #define LOG_H
  24
  25 #include <stdio.h>
  26 #ifndef WIN32
  27  #include <sys/time.h>
  28 #else
  29  #include <winsock2.h>
  30  #include <sys/timeb.h>
  31 #endif
  32
  33 #include <time.h>
  34 #include <string.h>
  35 #include <stdarg.h>
  36 #include "defines.h"
  37
  38 class Log
  39 {
  40   public:
  41     Log();
  42     ~Log();
  43     static Log* getInstance();
  44
  45     int init(int defaultLevel, char* fileName, int enabled);
  46     int shutdown();
  47     int log(char *fromModule, int level, char *message, ...);
  48     int status();
  49     void upLogLevel();
  50     void downLogLevel();
  51
  52     const static int CRAZY  = 0; // mad crazy things that should never happen
  53     const static int EMERG  = 1; // human assist required NOW
  54     const static int ALERT  = 2; // system unusable, but happy to sit there
  55     const static int CRIT   = 3; // still working, but maybe about to die
  56     const static int ERR    = 4; // that response is not even listed...
  57     const static int WARN   = 5; // this could be a bad thing. still running tho
  58     const static int NOTICE = 6; // significant good thing
  59     const static int INFO   = 7; // verbose good thing
  60     const static int DEBUG  = 8; // debug-level messages
  61
  62   private:
  63     static Log* instance;
  64     int initted;
  65     int logLevel;
  66     int enabled;
  67
  68     FILE *logfile;
  69 };
  70
  71 #endif
  72
  73 /*
  74
  75 Documentation
  76 -------------
  77
  78 This class is intended to be instatiated once by the core.
  79 For a one off use:
  80
  81 Log::getInstance()->log("<module-name>", Log::<levelname>, "<message>");
  82
  83 Or, a pointer can be stored and used:
  84
  85 Log *myptr = Log::getInstance();
  86
  87 myptr->log("<module-name>", Log::<levelname>, "<message>");
  88 myptr->log("<module-name>", Log::<levelname>, "<message>");
  89
  90 Level usages are above.
  91
  92 The message parameter in the log function can be used in the same way as printf, eg.
  93
  94 myptr->log("<module-name>", Log::<levelname>, "Success: %s %i", stringpointer, integer);
  95
  96 */