xt_log.h

浏览该文件的文档.

 
#ifndef __XT_LOG_H__
#define __XT_LOG_H__
 
/* ==================== [Includes] ========================================== */
 
#include <stdio.h>
#include <stdint.h>
#include <stdarg.h>
 
// TODO: xt_conf.h 机制？
 
// #include "xt_conf_internal.h"
// #include "xt_utils.h"
#include "xt_error.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_LOG_ERROR                 1   
#define XT_LOG_WARN                  2   
#define XT_LOG_INFO                  3   
#define XT_LOG_DEBUG                 4   
 
/* ==================== [Typedefs] ========================================== */

typedef void (*xt_assert_cb_t)(xt_err_t errcode);
 
/* ==================== [Global Prototypes] ================================= */


void xt_log_setup(uint8_t id, uint32_t baudrate, uint8_t tx_io, uint8_t rx_io);

void xt_log_set_level(uint8_t level);

uint8_t xt_log_get_level(void);
  /* 初始化与配置 */


void xt_log(uint8_t level, const char *tag, const char *fmt, ...);

void xt_log_dump_hex(const void *ptr, uint32_t size);

void xt_log_dump_hex_debug(const void *ptr, uint32_t size);
  /* 日志输出 */
 
/* 如果没定义 xt_vprintf/xt_printf 则以函数方式实现 */
#if !defined(xt_vprintf)

int xt_vprintf(const char *fmt, va_list args);
#endif
 
#if !defined(xt_printf)

int xt_printf(const char *fmt, ...);
#endif


void xt_assert_failed(xt_err_t errcode);

void xt_assert_set_callback(xt_assert_cb_t cb);
  /* 断言处理 */
 
/* ==================== [Macros] ============================================ */
 
#if !defined(xt_log_error)
#   define xt_log_error(format, ...)    xt_log(XT_LOG_ERROR, NULL, format, ##__VA_ARGS__)
#endif
#if !defined(xt_log_warn)
#   define xt_log_warn(format, ...)     xt_log(XT_LOG_WARN,  NULL, format, ##__VA_ARGS__)
#endif
#if !defined(xt_log_info)
#   define xt_log_info(format, ...)     xt_log(XT_LOG_INFO,  NULL, format, ##__VA_ARGS__)
#endif
#if !defined(xt_log_debug)
#   define xt_log_debug(format, ...)    xt_log(XT_LOG_DEBUG, NULL, format, ##__VA_ARGS__)
#endif
 
#if !defined(XT_LOGE)
#   define XT_LOGE(tag, format, ...)    xt_log(XT_LOG_ERROR, tag, format, ##__VA_ARGS__)
#endif
#if !defined(XT_LOGW)
#   define XT_LOGW(tag, format, ...)    xt_log(XT_LOG_WARN,  tag, format, ##__VA_ARGS__)
#endif
#if !defined(XT_LOGI)
#   define XT_LOGI(tag, format, ...)    xt_log(XT_LOG_INFO,  tag, format, ##__VA_ARGS__)
#endif
#if !defined(XT_LOGD)
#   define XT_LOGD(tag, format, ...)    xt_log(XT_LOG_DEBUG, tag, format, ##__VA_ARGS__)
#endif
 
#if !defined(XT_ASSERT_MSG)
#   define XT_ASSERT_MSG(expr, errcode)  \
        do { \
            if (!(expr)) { \
                xt_log_error("assert failed:%s:%d:err:%d", __FUNCTION__, __LINE__, (errcode)); \
                xt_assert_failed(errcode); \
            } \
        } while(0)
#endif
  /* xt_log */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_LOG_H__ */