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 <boost/thread/mutex.hpp>
  28 #include <boost/filesystem.hpp>
  29 #include <boost/signals2.hpp>
  30 #include <string>
  31
  32 /** @class Log
  33  *  @brief A very simple logging class.
  34  */
  35 class Log : public boost::noncopyable
  36 {
  37 public:
  38         Log ();
  39         virtual ~Log () {}
  40
  41         static const int TYPE_GENERAL;
  42         static const int TYPE_WARNING;
  43         static const int TYPE_ERROR;
  44         static const int TYPE_DEBUG;
  45         static const int TYPE_TIMING;
  46
  47         void log (std::string message, int type);
  48         void microsecond_log (std::string message, int type);
  49
  50         void set_types (int types);
  51
  52         virtual std::string head_and_tail (int amount = 1024) const = 0;
  53
  54 protected:
  55
  56         /** mutex to protect the log */
  57         mutable boost::mutex _mutex;
  58
  59 private:
  60         virtual void do_log (std::string m) = 0;
  61         void config_changed ();
  62
  63         /** bit-field of log types which should be put into the log (others are ignored) */
  64         int _types;
  65         boost::signals2::scoped_connection _config_connection;
  66 };
  67
  68 class FileLog : public Log
  69 {
  70 public:
  71         FileLog (boost::filesystem::path file);
  72
  73         std::string head_and_tail (int amount = 1024) const;
  74
  75 private:
  76         void do_log (std::string m);
  77         /** filename to write to */
  78         boost::filesystem::path _file;
  79 };
  80
  81 class NullLog : public Log
  82 {
  83 public:
  84         std::string head_and_tail (int) const {
  85                 return "";
  86         }
  87
  88 private:
  89         void do_log (std::string) {}
  90 };
  91
  92 #endif