file_logger.h

Go to the documentation of this file.

#ifndef FILE_LOGGER_CLASS
#define FILE_LOGGER_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : file_logger                                                       *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2000-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
 
#include "console_logger.h"
#include "eol_aware.h"
#include "filter_set.h"
 
#include <basis/astring.h>
#include <basis/contracts.h>
#include <basis/functions.h>
#include <basis/mutex.h>
#include <filesystem/byte_filer.h>
#include <textual/parser_bits.h>
 
namespace loggers {
 
class file_logger : public virtual standard_log_base
{
public:
  file_logger();
 
  file_logger(const basis::astring &filename, int limit = DEFAULT_LOG_FILE_SIZE);
 
  virtual ~file_logger();
 
  DEFINE_CLASS_NAME("file_logger");
 
  enum limits {
    DEFAULT_LOG_FILE_SIZE = 0x10F00D
  };
 
  bool good() const;
 
  bool reopen();
 
  basis::outcome log(const basis::base_string &info, int filter = basis::ALWAYS_PRINT);
 
  basis::outcome log_bytes(const basis::byte_array &to_log, int filter = basis::ALWAYS_PRINT);
 
  basis::outcome format_bytes(const basis::byte_array &to_log, int filter = basis::ALWAYS_PRINT);
 
  basis::astring name() const;
  void name(const basis::astring &new_name);
 
  int limit() const { return int(_file_limit); }
  void limit(int new_limit) { _file_limit = new_limit; }
 
  void flush();
 
  void truncate(size_t new_size);
 
 
  static basis::astring log_file_for_app_name();
 
private:
  basis::astring *_filename;  
  size_t _file_limit;  
  filesystem::byte_filer *_outfile;  
  basis::mutex *_flock;  
 
  int size_reduction() const;
 
  bool open_file();
 
  void close_file();
 
  // unavailable.
  file_logger(const file_logger &);
  file_logger &operator =(const file_logger &);
};
 
 
#define SETUP_FILE_LOGGER { \
  loggers::standard_log_base *old_log = loggers::program_wide_logger::set \
    (new loggers::file_logger(loggers::file_logger::log_file_for_app_name())); \
  WHACK(old_log); \
}
 
} //namespace.
 
#endif