DwmFileLogger.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2007, 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 _DWMFILELOGGER_HH_
#define _DWMFILELOGGER_HH_
 
extern "C" {
#include <inttypes.h>
#include <stdio.h>
#include <syslog.h>
}
 
#include <map>
#include <mutex>
#include <string>
 
namespace Dwm {
 
  //----------------------------------------------------------------------
  //----------------------------------------------------------------------
  class FileLogger
  {
  public:
    typedef enum {
      e_notBuffered   = _IONBF,
      e_lineBuffered  = _IOLBF,
      e_blockBuffered = _IOFBF
    } BufferingType;
    
    static const uint32_t  k_defaultRolloverSize      = 100 * 1024;
    static const uint32_t  k_defaultNumRolloverFiles  = 1;
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    FileLogger();
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    ~FileLogger();
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool Open(const std::string & ident, int logopt, 
              const std::string & filename,
              BufferingType bufferingType = e_blockBuffered);
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    std::string FilePrefix() const;
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool IsOpen() const;
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool Close();
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool Log(int priority, const char * message, ...);
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool Log(const std::string & filename, int lineno, 
             const std::string & function, int priority, 
             const char * message, ...);
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool VaLog(int priority, const std::string & message, 
               va_list & vaList);
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool VaLog(const std::string & filename, int lineno, 
               const std::string & function, int priority,
               const std::string & message, va_list & vaList);
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool Flush();
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    int MinimumPriority() const;
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    int MinimumPriority(int minimumPriority);
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool ShowPriorities() const;
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool ShowPriorities(bool showPriorities);
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    uint32_t RolloverSize() const;
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool ShowFunction() const;
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool ShowFunction(bool showFunction);
       
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool ShowFileLocation() const;
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool ShowFileLocation(bool showFileLocation);
       
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    uint32_t RolloverSize(uint32_t rolloverSize);
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    uint32_t NumRolloverFiles() const;
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    uint32_t NumRolloverFiles(uint32_t numRolloverFiles);
 
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool SetPriorities(const std::map<int, std::pair<std::string,std::string> > & priorities);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string PriorityTag(int priority);
    
  private:
    int                        _logOptions;
    int                        _minimumPriority;
    std::string                _ident;
    bool                       _showPriorities;
    bool                       _showFunction;
    bool                       _showFileLocation;
    std::string                _hostName;
    std::string                _filePrefix;
    FILE                      *_file;
    off_t                      _rolloverSize;
    uint32_t                   _numRolloverFiles;
    off_t                      _currentFilePosition;
    BufferingType              _bufferingType;
    
    mutable std::mutex         _mutex;
    std::map<std::string,int>  _priorityNames;
    std::map<int,std::string>  _priorityTags;
 
    static const std::map<std::string,int>  _defaultPriorityNames;
    static const std::map<int,std::string>  _defaultPriorityTags;
 
    bool Lock() const;
    bool Unlock() const;
    bool CloseNoLock();
    bool OpenNoLock(const std::string & ident, int logopt,
                    const std::string & filename,
                    BufferingType bufferingType = e_blockBuffered);
    bool OpenFile(const std::string & filename);
    bool RollFilesOver();
    void InitializePriorities();
  };
 
}  // namespace Dwm
 
#endif  // _DWMFILELOGGER_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------