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 <sys/timeb.h>
  30 #endif
  31
  32 #include <time.h>
  33 #include <string.h>
  34 #include <stdarg.h>
  35 #include "defines.h"
  36
  37 class Log
  38 {
  39   public:
  40     Log();
  41     ~Log();
  42     static Log* getInstance();
  43
  44     int init(int defaultLevel, char* fileName, int enabled);
  45     int shutdown();
  46     int log(char *fromModule, int level, char *message, ...);
  47     int status();
  48     void upLogLevel();
  49     void downLogLevel();
  50
  51     const static int CRAZY  = 0; // mad crazy things that should never happen
  52     const static int EMERG  = 1; // human assist required NOW
  53     const static int ALERT  = 2; // system unusable, but happy to sit there
  54     const static int CRIT   = 3; // still working, but maybe about to die
  55     const static int ERR    = 4; // that response is not even listed...
  56     const static int WARN   = 5; // this could be a bad thing. still running tho
  57     const static int NOTICE = 6; // significant good thing
  58     const static int INFO   = 7; // verbose good thing
  59     const static int DEBUG  = 8; // debug-level messages
  60
  61   private:
  62     static Log* instance;
  63     int initted;
  64     int logLevel;
  65     int enabled;
  66
  67     FILE *logfile;
  68 };
  69
  70 #endif
  71
  72 /*
  73
  74 Documentation
  75 -------------
  76
  77 This class is intended to be instatiated once by the core.
  78 For a one off use:
  79
  80 Log::getInstance()->log("<module-name>", Log::<levelname>, "<message>");
  81
  82 Or, a pointer can be stored and used:
  83
  84 Log *myptr = Log::getInstance();
  85
  86 myptr->log("<module-name>", Log::<levelname>, "<message>");
  87 myptr->log("<module-name>", Log::<levelname>, "<message>");
  88
  89 Level usages are above.
  90
  91 The message parameter in the log function can be used in the same way as printf, eg.
  92
  93 myptr->log("<module-name>", Log::<levelname>, "Success: %s %i", stringpointer, integer);
  94
  95 */