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 <dcp/types.h>
  28 #include <boost/thread/mutex.hpp>
  29 #include <boost/filesystem.hpp>
  30 #include <boost/signals2.hpp>
  31 #include <string>
  32
  33 /** @class Log
  34  *  @brief A very simple logging class.
  35  */
  36 class Log : public boost::noncopyable
  37 {
  38 public:
  39         Log ();
  40         virtual ~Log () {}
  41
  42         static const int TYPE_GENERAL;
  43         static const int TYPE_WARNING;
  44         static const int TYPE_ERROR;
  45         static const int TYPE_DEBUG_DECODE;
  46         static const int TYPE_DEBUG_ENCODE;
  47         static const int TYPE_TIMING;
  48
  49         void log (std::string message, int type);
  50         void microsecond_log (std::string message, int type);
  51         void dcp_log (dcp::NoteType type, std::string message);
  52
  53         void set_types (int types);
  54
  55         /** @param amount Approximate number of bytes to return; the returned value
  56          *  may be shorter or longer than this.
  57          */
  58         virtual std::string head_and_tail (int amount = 1024) const = 0;
  59
  60 protected:
  61
  62         /** mutex to protect the log */
  63         mutable boost::mutex _mutex;
  64
  65 private:
  66         virtual void do_log (std::string m) = 0;
  67         void config_changed ();
  68
  69         /** bit-field of log types which should be put into the log (others are ignored) */
  70         int _types;
  71         boost::signals2::scoped_connection _config_connection;
  72 };
  73
  74 #endif