src/lib/log.h

   1 /*
   2     Copyright (C) 2012-2021 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
  22 #ifndef DCPOMATIC_LOG_H
  23 #define DCPOMATIC_LOG_H
  24
  25
  26 /** @file src/log.h
  27  *  @brief A very simple logging class.
  28  */
  29
  30
  31 #include "log_entry.h"
  32 #include <dcp/types.h>
  33 #include <boost/thread/mutex.hpp>
  34 #include <boost/filesystem.hpp>
  35 #include <boost/signals2.hpp>
  36 #include <string>
  37
  38
  39 /** @class Log
  40  *  @brief A very simple logging class.
  41  */
  42 class Log
  43 {
  44 public:
  45         Log ();
  46         virtual ~Log () {}
  47
  48         Log (Log const&) = delete;
  49         Log& operator= (Log const&) = delete;
  50
  51         void log (std::shared_ptr<const LogEntry> entry);
  52         void log (std::string message, int type);
  53         void dcp_log (dcp::NoteType type, std::string message);
  54
  55         void set_types (int types);
  56         int types () const {
  57                 return _types;
  58         }
  59
  60         /** @param amount Approximate number of bytes to return; the returned value
  61          *  may be shorter or longer than this.
  62          */
  63         virtual std::string head_and_tail (int amount = 1024) const {
  64                 (void) amount;
  65                 return "";
  66         }
  67
  68 protected:
  69
  70         /** mutex to protect the log */
  71         mutable boost::mutex _mutex;
  72
  73 private:
  74         virtual void do_log (std::shared_ptr<const LogEntry> entry) = 0;
  75
  76         /** bit-field of log types which should be put into the log (others are ignored) */
  77         int _types = 0;
  78 };
  79
  80
  81 #endif