src/lib/log.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_LOG_H
  22 #define DCPOMATIC_LOG_H
  23
  24 /** @file src/log.h
  25  *  @brief A very simple logging class.
  26  */
  27
  28 #include "log_entry.h"
  29 #include <dcp/types.h>
  30 #include <boost/thread/mutex.hpp>
  31 #include <boost/filesystem.hpp>
  32 #include <boost/signals2.hpp>
  33 #include <string>
  34
  35 /** @class Log
  36  *  @brief A very simple logging class.
  37  */
  38 class Log : public boost::noncopyable
  39 {
  40 public:
  41         Log ();
  42         virtual ~Log () {}
  43
  44         void log (boost::shared_ptr<const LogEntry> entry);
  45         void log (std::string message, int type);
  46         void dcp_log (dcp::NoteType type, std::string message);
  47
  48         void set_types (int types);
  49
  50         /** @param amount Approximate number of bytes to return; the returned value
  51          *  may be shorter or longer than this.
  52          */
  53         virtual std::string head_and_tail (int amount = 1024) const = 0;
  54
  55 protected:
  56
  57         /** mutex to protect the log */
  58         mutable boost::mutex _mutex;
  59
  60 private:
  61         virtual void do_log (boost::shared_ptr<const LogEntry> entry) = 0;
  62         void config_changed ();
  63
  64         /** bit-field of log types which should be put into the log (others are ignored) */
  65         int _types;
  66         boost::signals2::scoped_connection _config_connection;
  67 };
  68
  69 #endif