libdbg.h

Go to the documentation of this file.

 
#ifndef _PSP2_LIBDBG_H_
#define _PSP2_LIBDBG_H_
 
#include <psp2/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum SceDbgLogLevel {
    SCE_DBG_LOG_LEVEL_TRACE = 0, /* An extremely verbose logging level, mostly useful for internal developers. */
    SCE_DBG_LOG_LEVEL_DEBUG,     /* A diagnostic logging level. */
    SCE_DBG_LOG_LEVEL_INFO,      /* An informational logging level. */
    SCE_DBG_LOG_LEVEL_WARNING,   /* A logging level that gives warnings of situations detrimental to proper execution. */
    SCE_DBG_LOG_LEVEL_ERROR,     /* A logging level that will report erroneous conditions in execution. */
    SCE_DBG_NUM_LOG_LEVELS       /* The number of logging levels available. */
} SceDbgLogLevel;
 
#ifndef SCE_DBG_COMPONENT
#define SCE_DBG_COMPONENT NULL
#endif /* SCE_DBG_COMPONENT */
 
#ifndef SCE_DBG_BREAK_ON_ASSERT
#define SCE_DBG_BREAK_ON_ASSERT 1
#endif /* SCE_DBG_BREAK_ON_ASSERT */
 
#ifndef SCE_DBG_BREAK_ACTION
#define SCE_DBG_BREAK_ACTION asm volatile ("bkpt 0x0")
#endif /* SCE_DBG_BREAK_ACTION */
 
#ifndef NDEBUG
#define SCE_DBG_ASSERT(expression) \
do { \
    if (!(expression)) { \
        sceDbgAssertionHandler(__FILE__, __LINE__, 0, SCE_DBG_COMPONENT, "Assertion ("#expression") failed.\n"); \
        if (SCE_DBG_BREAK_ON_ASSERT) \
            SCE_DBG_BREAK_ACTION; \
    } \
} while (0)
#define SCE_DBG_ASSERT_MSG(expression, msg, ...) \
do { \
    if (!(expression)) { \
        sceDbgAssertionHandler(__FILE__, __LINE__, 0, SCE_DBG_COMPONENT, msg, ##__VA_ARGS__); \
        if (SCE_DBG_BREAK_ON_ASSERT) \
            SCE_DBG_BREAK_ACTION; \
    } \
} while (0)
#define SCE_DBG_LOG(logLevel, msg, ...) \
sceDbgLoggingHandler(__FILE__, __LINE__, logLevel, SCE_DBG_COMPONENT, msg, ##__VA_ARGS__)
 
#define SCE_DBG_LOG_TRACE(msg, ...) SCE_DBG_LOG(SCE_DBG_LOG_LEVEL_TRACE, msg, ##__VA_ARGS__)
#define SCE_DBG_LOG_INFO(msg, ...) SCE_DBG_LOG(SCE_DBG_LOG_LEVEL_INFO, msg, ##__VA_ARGS__)
#define SCE_DBG_LOG_DEBUG(msg, ...) SCE_DBG_LOG(SCE_DBG_LOG_LEVEL_DEBUG, msg, ##__VA_ARGS__)
#define SCE_DBG_LOG_WARNING(msg, ...) SCE_DBG_LOG(SCE_DBG_LOG_LEVEL_WARNING, msg, ##__VA_ARGS__)
#define SCE_DBG_LOG_ERROR(msg, ...) SCE_DBG_LOG(SCE_DBG_LOG_LEVEL_ERROR, msg, ##__VA_ARGS__)
#else // Disable macros if NDEBUG is defined.
#define SCE_DBG_ASSERT(expression)
#define SCE_DBG_ASSERT_MSG(expression, msg, ...)
#define SCE_DBG_LOG(msg, ...)
 
#define SCE_DBG_LOG_TRACE(msg, ...)
#define SCE_DBG_LOG_INFO(msg, ...)
#define SCE_DBG_LOG_DEBUG(msg, ...)
#define SCE_DBG_LOG_WARNING(msg, ...)
#define SCE_DBG_LOG_ERROR(msg, ...)
#endif /* NDEBUG */
 
int sceDbgAssertionHandler(const char* file, int line, int unk, const char* component, const char* msg, ...);
int sceDbgLoggingHandler(const char* file, int line, SceDbgLogLevel logLevel, const char* component, const char* msg, ...);
 
void sceDbgSetBreakOnErrorState(SceBool breakOnError);
void sceDbgSetBreakOnWarningState(SceBool breakOnWarning);
void sceDbgSetMinimumLogLevel(SceDbgLogLevel level);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _PSP2_LIBDBG_H_ */