xf_utils_log.h

浏览该文件的文档.

 
#ifndef __XF_UTILS_LOG_H__
#define __XF_UTILS_LOG_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_utils_log_config.h"
#include "../xf_common/xf_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
#define XF_LOG_NONE             (0)
#define XF_LOG_USER             (1)
#define XF_LOG_ERROR            (2)
#define XF_LOG_WARN             (3)
#define XF_LOG_INFO             (4)
#define XF_LOG_DEBUG            (5)
#define XF_LOG_VERBOSE          (6)
 
#if XF_LOG_DUMP_IS_ENABLE
 
#define XF_DUMP_HEAD_BIT        (0) 
#define XF_DUMP_ASCII_BIT       (1) 
#define XF_DUMP_ESCAPE_BIT      (2) 
#define XF_DUMP_TAIL_BIT        (3) 
#define XF_DUMP_BIT(nr)         BIT(nr)
 
#define XF_DUMP_TABLE           (XF_DUMP_BIT(XF_DUMP_HEAD_BIT) | XF_DUMP_BIT(XF_DUMP_TAIL_BIT))
 
/* 只输出 16 进制格式数据 */
#define XF_DUMP_FLAG_HEX_ONLY           (XF_DUMP_TABLE)
/* 输出 16 进制格式数据并带有 ASCII 字符 */
#define XF_DUMP_FLAG_HEX_ASCII          (XF_DUMP_BIT(XF_DUMP_ASCII_BIT) | XF_DUMP_TABLE)
/* 输出 16 进制格式数据、 ASCII 字符、转义字符，其余输出 16 进制原始值 */
#define XF_DUMP_FLAG_HEX_ASCII_ESCAPE   (XF_DUMP_FLAG_HEX_ASCII | XF_DUMP_BIT(XF_DUMP_ESCAPE_BIT))
 
#endif /* XF_LOG_DUMP_IS_ENABLE */
 
/* ==================== [Typedefs] ========================================== */
 
/* ==================== [Global Prototypes] ================================= */
 
#if XF_LOG_DUMP_IS_ENABLE
xf_err_t xf_dump_mem(void *addr, size_t size, uint8_t flags_mask);
#endif
 
/* ==================== [Macros] ============================================ */
 
#if XF_LOG_LEVEL >= XF_LOG_USER
#   define XF_LOGU(tag, format, ...)  xf_log_level(XF_LOG_USER,     tag, format, ##__VA_ARGS__)
#else
#   define XF_LOGU(tag, format, ...)  (void)(tag)
#endif
 
#if XF_LOG_LEVEL >= XF_LOG_ERROR
#   define XF_LOGE(tag, format, ...)  xf_log_level(XF_LOG_ERROR,    tag, format, ##__VA_ARGS__)
#else
#   define XF_LOGE(tag, format, ...)  (void)(tag)
#endif
 
#if XF_LOG_LEVEL >= XF_LOG_WARN
#   define XF_LOGW(tag, format, ...)  xf_log_level(XF_LOG_WARN,     tag, format, ##__VA_ARGS__)
#else
#   define XF_LOGW(tag, format, ...)  (void)(tag)
#endif
 
#if XF_LOG_LEVEL >= XF_LOG_INFO
#   define XF_LOGI(tag, format, ...)  xf_log_level(XF_LOG_INFO,     tag, format, ##__VA_ARGS__)
#else
#   define XF_LOGI(tag, format, ...)  (void)(tag)
#endif
 
#if XF_LOG_LEVEL >= XF_LOG_DEBUG
#   define XF_LOGD(tag, format, ...)  xf_log_level(XF_LOG_DEBUG,    tag, format, ##__VA_ARGS__)
#else
#   define XF_LOGD(tag, format, ...)  (void)(tag)
#endif
 
#if XF_LOG_LEVEL >= XF_LOG_VERBOSE
#   define XF_LOGV(tag, format, ...)  xf_log_level(XF_LOG_VERBOSE,  tag, format, ##__VA_ARGS__)
#else
#   define XF_LOGV(tag, format, ...)  (void)(tag)
#endif
 
#if XF_LOG_DUMP_IS_ENABLE
#define XF_LOG_BUFFER_HEX(buffer, buffer_len) \
    xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ONLY)
 
#define XF_LOG_BUFFER_HEXDUMP(buffer, buffer_len) \
    xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ASCII)
 
#define XF_LOG_BUFFER_HEXDUMP_ESCAPE(buffer, buffer_len) \
    xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ASCII_ESCAPE)
 
#else
 
#define XF_LOG_BUFFER_HEX(buffer, buffer_len)
#define XF_LOG_BUFFER_HEXDUMP(buffer, buffer_len)
#define XF_LOG_BUFFER_HEXDUMP_ESCAPE(buffer, buffer_len)
 
#endif // XF_LOG_DUMP_IS_ENABLE
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XF_UTILS_LOG_H__