Log.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2013, 2025 (http://safirsdkcore.com)
*
* Created by: Anders Widén
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
#ifndef __SAFIR_LOGGING_LOG_H__
#define __SAFIR_LOGGING_LOG_H__
 
#include <Safir/Utilities/Internal/VisibilityHelpers.h>
 
#ifdef logging_cpp_EXPORTS
#  define LOGGING_CPP_API SAFIR_HELPER_DLL_EXPORT
#else
#  define LOGGING_CPP_API SAFIR_HELPER_DLL_IMPORT
#  define SAFIR_LIBRARY_NAME "logging_cpp"
#  include <Safir/Utilities/Internal/AutoLink.h>
#endif
#define LOGGING_CPP_LOCAL SAFIR_HELPER_DLL_LOCAL
 
#include <string>
 
/* For C++20 or later we add utility functions with formatting.
 * Visual Studio does not update the __cplusplus macro unless the
 * `/Zc:__cplusplus` compiler switch is supplied, but it always sets
 * _MSVC_LANG to the correct value.  Check both to detect C++20.
 */
#if ((__cplusplus >= 202002L) || (defined(_MSVC_LANG) && (_MSVC_LANG >= 202002L)))
#  if defined(__has_include)
#    if __has_include(<format>)
#      include <format>
#    endif
#  endif
#endif
 
namespace Safir
{
namespace Logging
{
    enum Severity
    {
        Emergency = 0,

        Alert,

        Critical,

        Error,

        Warning,

        Notice,

        Informational,

        Debug
    };
 

    LOGGING_CPP_API void SendSystemLog(const Severity severity,
                                       const std::wstring& message);
 
    // For C++20 or later we add utility functions with formatting
#if __cpp_lib_format
    namespace Internal
    {
        //declare an internal helper function
        LOGGING_CPP_API void LogFormattingException(const Severity severity,
                                                    const std::wstring& fmt,
                                                    const std::exception& e);
    }

    template<typename... Args>
    void SendSystemLog(const Severity severity,
                       std::wformat_string<Args...> message,
                       Args&&... args)
    {
        try
        {
            SendSystemLog(severity, std::format(message, std::forward<Args>(args)...));
        }
        catch (const std::exception& e)
        {
            Internal::LogFormattingException(severity,std::wstring(message.get()),e);
        }
    }

    template<typename... Args>
    void SendEmergency(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Emergency, message, std::forward<Args>(args)...);
    }

    template<typename... Args>
    void SendAlert(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Alert, message, std::forward<Args>(args)...);
    }

    template<typename... Args>
    void SendCritical(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Critical, message, std::forward<Args>(args)...);
    }

    template<typename... Args>
    void SendError(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Error, message, std::forward<Args>(args)...);
    }

    template<typename... Args>
    void SendWarning(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Warning, message, std::forward<Args>(args)...);
    }

    template<typename... Args>
    void SendNotice(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Notice, message, std::forward<Args>(args)...);
    }

    template<typename... Args>
    void SendInformational(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Informational, message, std::forward<Args>(args)...);
    }

    template<typename... Args>
    void SendDebug(std::wformat_string<Args...> message, Args&&... args)
    {
        SendSystemLog(Debug, message, std::forward<Args>(args)...);
    }
 
#endif
 
 
}
}
 
 
#endif