src/lib/log.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   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., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_LOG_H
  21 #define DCPOMATIC_LOG_H
  22
  23 /** @file src/log.h
  24  *  @brief A very simple logging class.
  25  */
  26
  27 #include <string>
  28 #include <boost/thread/mutex.hpp>
  29 #include <boost/filesystem.hpp>
  30
  31 /** @class Log
  32  *  @brief A very simple logging class.
  33  */
  34 class Log : public boost::noncopyable
  35 {
  36 public:
  37         Log ();
  38         virtual ~Log () {}
  39
  40         static const int GENERAL;
  41         static const int WARNING;
  42         static const int ERROR;
  43         static const int TIMING;
  44
  45         void log (std::string message, int type);
  46         void microsecond_log (std::string message, int type);
  47
  48         void set_types (int types);
  49         void set_types (std::string types);
  50
  51 protected:
  52         /** mutex to protect the log */
  53         boost::mutex _mutex;
  54
  55 private:
  56         virtual void do_log (std::string m) = 0;
  57         void config_changed ();
  58
  59         /** bit-field of log types which should be put into the log (others are ignored) */
  60         int _types;
  61 };
  62
  63 class FileLog : public Log
  64 {
  65 public:
  66         FileLog (boost::filesystem::path file);
  67
  68 private:
  69         void do_log (std::string m);
  70         /** filename to write to */
  71         boost::filesystem::path _file;
  72 };
  73
  74 class NullLog : public Log
  75 {
  76 public:
  77
  78 private:
  79         void do_log (std::string) {}
  80 };
  81
  82 #endif