sbgDebug.h

Go to the documentation of this file.

#ifndef SBG_DEBUG_H
#define SBG_DEBUG_H
 
// sbgCommonLib headers
#include <sbgDefines.h>
 
#ifndef SBG_DEBUG_LOG_CATEGORY
    #define SBG_DEBUG_LOG_CATEGORY      ("None")
#endif
 
//----------------------------------------------------------------------//
//- Errors and warning definitions                                     -//
//----------------------------------------------------------------------//

typedef enum _SbgDebugLogType
{
    SBG_DEBUG_LOG_TYPE_ERROR,                   
    SBG_DEBUG_LOG_TYPE_WARNING,                   
    SBG_DEBUG_LOG_TYPE_INFO,                 
    SBG_DEBUG_LOG_TYPE_DEBUG                    
} SbgDebugLogType;
 
//----------------------------------------------------------------------//
//- Errors and warning macros                                          -//
//----------------------------------------------------------------------//

#define SBG_LOG_ERROR_CALL(errorCode, format, ...)      sbgPlatformDebugLogMsg((const char*)__BASE_FILE__, (const char*)__func__, __LINE__, SBG_DEBUG_LOG_CATEGORY, SBG_DEBUG_LOG_TYPE_ERROR, errorCode, format, ##__VA_ARGS__)
 
#if SBG_CONFIG_ENABLE_LOG_ERROR == 1
    #define SBG_LOG_ERROR                               SBG_LOG_ERROR_CALL
#else
    #define SBG_LOG_ERROR(format, ...)                  ((void)sizeof(SBG_LOG_ERROR_CALL(format, ## __VA_ARGS__), 0))
#endif

#define SBG_LOG_WARNING_CALL(errorCode, format, ...)    sbgPlatformDebugLogMsg((const char*)__BASE_FILE__, (const char*)__func__, __LINE__, SBG_DEBUG_LOG_CATEGORY, SBG_DEBUG_LOG_TYPE_WARNING, errorCode, format, ##__VA_ARGS__)
 
#if SBG_CONFIG_ENABLE_LOG_WARNING == 1
    #define SBG_LOG_WARNING                             SBG_LOG_WARNING_CALL
#else
    #define SBG_LOG_WARNING(format, ...)                ((void)sizeof(SBG_LOG_WARNING_CALL(format, ## __VA_ARGS__), 0))
#endif

#define SBG_LOG_INFO_CALL(format, ...)                  sbgPlatformDebugLogMsg((const char*)__BASE_FILE__, (const char*)__func__, __LINE__, SBG_DEBUG_LOG_CATEGORY, SBG_DEBUG_LOG_TYPE_INFO, SBG_NO_ERROR, format, ##__VA_ARGS__)
 
#if SBG_CONFIG_ENABLE_LOG_INFO == 1
    #define SBG_LOG_INFO                                SBG_LOG_INFO_CALL
#else
    #define SBG_LOG_INFO(format, ...)                   ((void)sizeof(SBG_LOG_INFO_CALL(format, ## __VA_ARGS__), 0))
#endif

#define SBG_LOG_DEBUG_CALL(format, ...)                 sbgPlatformDebugLogMsg((const char*)__BASE_FILE__, (const char*)__func__, __LINE__, SBG_DEBUG_LOG_CATEGORY, SBG_DEBUG_LOG_TYPE_DEBUG, SBG_NO_ERROR, format, ##__VA_ARGS__)
 
#if SBG_CONFIG_ENABLE_LOG_DEBUG == 1
    #define SBG_LOG_DEBUG                               SBG_LOG_DEBUG_CALL
#else
    #define SBG_LOG_DEBUG(format, ...)                  ((void)sizeof(SBG_LOG_DEBUG_CALL(format, ## __VA_ARGS__), 0))
#endif
 
//----------------------------------------------------------------------//
//- Inline functions                                                   -//
//----------------------------------------------------------------------//

SBG_INLINE const char *sbgDebugLogTypeToStr(SbgDebugLogType logType)
{
    const char              *pString;
 
    switch (logType)
    {
    case SBG_DEBUG_LOG_TYPE_ERROR:
        pString = "error";
        break;
    case SBG_DEBUG_LOG_TYPE_WARNING:
        pString = "warning";
        break;
    case SBG_DEBUG_LOG_TYPE_INFO:
        pString = "info";
        break;
    case SBG_DEBUG_LOG_TYPE_DEBUG:
        pString = "debug";
        break;
    default:
        pString = "unknown";
        break;
    }
 
    return pString;
}
 
//----------------------------------------------------------------------//
//- Public functions                                                   -//
//----------------------------------------------------------------------//

void sbgDebugHexDump(const char *pPrefix, const void *pBuffer, size_t size);
 
#endif // SBG_DEBUG_H