DwmSysLogger.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2007, 2016, 2021, 2024
//  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 _DWMSYSLOGGER_HH_
#define _DWMSYSLOGGER_HH_
 
extern "C" {
  #include <errno.h>
  #include <stdarg.h>
  #include <syslog.h>
}
 
#include <cstdio>
#include <version>
#include <mutex>
#include <source_location>
#include <string>
 
#include "DwmPortability.hh"
 
#if (defined DWM_HAVE_STD_FORMAT)
  #include <format>
#else
  #if (defined DWM_HAVE_LIBFMT)
    #include <fmt/format.h>
  #endif
#endif
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class SysLogger
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Open(const char *ident, int logopt, int facility);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Open(const char *ident, int logopt,
                     const std::string & facility);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Close();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Log(int priority, const char *message, ...);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Log(const std::string & filename, int lineno,
                    const std::string & function, int priority,
                    const char *message, ...);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Log(std::source_location loc, int priority,
                    const char *message, ...);
    
#if (defined DWM_HAVE_STD_FORMAT)
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename ...Args>
    static bool FmtLog(std::source_location loc, int priority,
                       std::format_string<Args...> fm,
                       Args&&... args)
    {
      //  The reason I put the formatted string into the format string
      //  of the downstream Log() call instead of separately using a
      //  "%s": I want to be able to still use the convenient "%m" in
      //  a log message, and it must be in the format string for that
      //  to happen downstream.  This is likely to change at a later date.
      return Log(loc, priority,
                 std::format(fm, std::forward<Args>(args)...).c_str());
    }
 
#elif (defined DWM_HAVE_LIBFMT)
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename ...Args>
    static bool FmtLog(std::source_location loc, int priority,
                       fmt::format_string<Args...> fm,
                       Args&&... args)
    {
      //  The reason I put the formatted string into the format string
      //  of the downstream Log() call instead of separately using a
      //  "%s": I want to be able to still use the convenient "%m" in
      //  a log message, and it must be in the format string for that
      //  to happen downstream.  This is likely to change at a later date.
      return Log(loc, priority,
                 fmt::format(fm, std::forward<Args>(args)...).c_str());
    }
#endif
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool VaLog(int priority, const std::string & message, 
                      va_list & vaList);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool VaLog(const std::string & filename, int lineno,
                      const std::string & function, int priority,
                      const std::string & message, va_list & vaList);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool ShowPriorities();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool ShowPriorities(bool showPriorities);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool ShowFileLocation();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool ShowFileLocation(bool showFileLocation);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool ShowFunction();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool ShowFunction(bool showFunction);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static int MinimumPriority();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static int MinimumPriority(int minimumPriority);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static int MinimumPriority(const std::string & minimumPriority);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::string PriorityTag(int priority);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static int PriorityValue(const std::string & name);
    
  private:
    static std::mutex   _mutex;
    static bool         _isOpen;
    static int          _logOptions;
    static std::string  _ident;
    static int          _logFacility;
    static bool         _showPriorities;
    static bool         _showFunction;
    static bool         _showFileLocation;
    static int          _minimumPriority;
  };
 
}  // namespace Dwm
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
#define Syslog(...)                                                          \
  Dwm::SysLogger::Log(std::source_location::current(),__VA_ARGS__)
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
#if (defined DWM_HAVE_STD_FORMAT || defined DWM_HAVE_LIBFMT)
  #define FSyslog(...)                                                       \
    Dwm::SysLogger::FmtLog(std::source_location::current(),__VA_ARGS__)
#endif
 
#endif  // _DWMSYSLOGGER_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------