DwmFileRoller.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2006, 2016
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//    endorse or promote products derived from this software without
//    specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================
 
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
 
#ifndef _DWMFILEROLLER_HH_
#define _DWMFILEROLLER_HH_
 
#include <cstdio>
#include <cstdlib>
#include <iostream>
#include <set>
#include <string>
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class FileRoller
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    typedef enum {
      e_compressionNone,
      e_compressionGzip,
      e_compressionBzip2
    } CompressionEnum;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    FileRoller(const std::string & dir,
               const std::string & prefix,
               size_t maxSize, size_t numFiles, 
               CompressionEnum compression = e_compressionNone);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FilesNeedRolling() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FilesNeedRolling(int fd) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FilesNeedRolling(std::ostream & os) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FilesNeedRolling(FILE *f) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool RollFiles();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t MaxSize() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t MaxSize(size_t maxSize);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t NumFiles() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t NumFiles(size_t numFiles);
    
  private:
    std::string      _dir;
    std::string      _prefix;
    off_t            _maxSize;
    size_t           _numFiles;
    CompressionEnum  _compression;
 
    bool GzipFile(const std::string & src, const std::string & dst) const;
    bool BzipFile(const std::string & src, const std::string & dst) const;
    bool GetFilename(size_t fileNum, std::string & filename) const;
    
  };
  
}  // namespace Dwm
 
#endif  // _DWMFILEROLLER_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------