xf_check

运行时检查宏。 更多...

xf_check 的协作图:

宏定义
#define	XF_CHECK_ACTION_RETURN(condition, retval, action)
	检查条件(condition)，成立则执行(action)，并 return (retval).
#define	XF_CHECK_ACTION_GOTO(condition, label, action)
	检查条件(condition)，成立则执行(action)，并跳转到(label).
#define	XF_CHECK(condition, retval, tag, format, ...)
	xfusion 检查宏（条件 成立 时则输出日志后返回）。
#define	XF_CHECK_GOTO(condition, label, tag, format, ...)
	xfusion 检查宏（条件 成立 时则输出日志后跳转）。
#define	XF_ASSERT(condition, retval, tag, format, ...)
	xfusion 断言宏（条件 不成立 时则输出日志后返回）。
#define	XF_ASSERT_GOTO(condition, label, tag, format, ...)
	xfusion 断言宏（条件 不成立 时则输出日志后跳转）。
#define	XF_ERROR_CHECK(expression)
	xfusion 错误检查宏（表达式 不等于 XF_OK 时则调用 XF_CHECK_ERROR_HANDLER）。

XF_CHECK_NO_ACTION
XF_RETURN_VOID、XF_ACTION_NO 是在 XF_CHECK 无需返回的情况使用： XF_CHECK(timer == NULL , XF_RETURN_VOID, TAG, "timer == NULL"); XF_CHECK_ACTION_RETURN(port_in == NULL, port_out, XF_ACTION_NO);
#define	XF_RETURN_VOID
#define	XF_ACTION_NO

详细描述

运行时检查宏。

宏定义说明

XF_RETURN_VOID

#define XF_RETURN_VOID

示例

examples/storage/fal/fal_flashdb/main/xf_main.c, examples/wireless/ble/sample_gatt_client/main/xf_main.c, examples/wireless/ble/sample_gatt_server/main/xf_main.c, examples/wireless/sle/sample_ssap_client/main/xf_main.c , 以及 examples/wireless/sle/sample_ssap_server/main/xf_main.c.

在文件 xf_check.h 第 47 行定义.

XF_ACTION_NO

#define XF_ACTION_NO

在文件 xf_check.h 第 48 行定义.

XF_CHECK_ACTION_RETURN

#define XF_CHECK_ACTION_RETURN	(		condition,
			retval,
			action
	)

值:

        do { \
            if (condition) { \
                do {action} while (0); \
                return retval; \
            } \
        } while (0)

检查条件(condition)，成立则执行(action)，并 return (retval).

参数

condition	判断条件。
retval	条件成立时的返回值。
action	条件成立时的执行的动作。

返回

retval 等同于参数 retval，可以为空。

在文件 xf_check.h 第 69 行定义.

XF_CHECK_ACTION_GOTO

#define XF_CHECK_ACTION_GOTO	(		condition,
			label,
			action
	)

值:

        do { \
            if (condition) { \
                do {action} while (0); \
                goto label; \
            } \
        } while (0)

检查条件(condition)，成立则执行(action)，并跳转到(label).

参数

condition	判断条件。
label	条件成立时，跳转到的标签。
action	条件成立时的执行的动作。

在文件 xf_check.h 第 88 行定义.

XF_CHECK

#define XF_CHECK	(		condition,
			retval,
			tag,
			format,
			...
	)

值:

        XF_CHECK_ACTION_RETURN( \
            !!(condition), retval, \
            XF_LOGE((tag), format, ##__VA_ARGS__); \
        )

xfusion 检查宏（条件 成立 时则输出日志后返回）。

• XF_CHECK*: 条件 成立 时执行。

参数

condition	判断条件。
retval	条件 成立 时的返回值。
tag	日志标签。
format	用户格式化字符串。
...	可变参数。

返回

retval 等同于参数 retval，可以为空。

示例

examples/storage/fal/fal_flashdb/main/xf_main.c, examples/wireless/ble/sample_gatt_client/main/xf_main.c, examples/wireless/ble/sample_gatt_server/main/xf_main.c, examples/wireless/sle/sample_ssap_client/main/xf_main.c , 以及 examples/wireless/sle/sample_ssap_server/main/xf_main.c.

在文件 xf_check.h 第 112 行定义.

XF_CHECK_GOTO

#define XF_CHECK_GOTO	(		condition,
			label,
			tag,
			format,
			...
	)

值:

        XF_CHECK_ACTION_GOTO( \
            !!(condition), label, \
            XF_LOGE((tag), format, ##__VA_ARGS__); \
        )

xfusion 检查宏（条件 成立 时则输出日志后跳转）。

参数

condition	判断条件。
label	条件 成立 时，跳转到的标签。
tag	日志标签。
format	用户格式化字符串。
...	可变参数。

在文件 xf_check.h 第 127 行定义.

XF_ASSERT

#define XF_ASSERT	(		condition,
			retval,
			tag,
			format,
			...
	)

值:

        XF_CHECK_ACTION_RETURN( \
            !(condition), retval, \
            XF_LOGE((tag), format, ##__VA_ARGS__); \
        )

xfusion 断言宏（条件 不成立 时则输出日志后返回）。

• XF_ASSERT*: 条件 不成立 时执行。

参数

condition	判断条件。
retval	条件 不成立 时的返回值。
tag	日志标签。
format	用户格式化字符串。
...	可变参数。

返回

retval 等同于参数 retval，可以为空。

在文件 xf_check.h 第 150 行定义.

XF_ASSERT_GOTO

#define XF_ASSERT_GOTO	(		condition,
			label,
			tag,
			format,
			...
	)

值:

        XF_CHECK_ACTION_GOTO( \
            !(condition), label, \
            XF_LOGE((tag), format, ##__VA_ARGS__); \
        )

xfusion 断言宏（条件 不成立 时则输出日志后跳转）。

参数

condition	判断条件。
label	条件 不成立 时，跳转到的标签。
tag	日志标签。
format	用户格式化字符串。
...	可变参数。

在文件 xf_check.h 第 165 行定义.

XF_ERROR_CHECK

#define XF_ERROR_CHECK

(

expression

)

值:

        do { \
            xf_err_t __err = (expression); \
            if (unlikely((__err) != XF_OK)) { \
                XF_LOGE("xf_check", "An error occurred: " XSTR(expression != XF_OK)); \
                XF_CHECK_ERROR_HANDLER \
            } \
        } while (0)

xfusion 错误检查宏（表达式 不等于 XF_OK 时则调用 XF_CHECK_ERROR_HANDLER）。

参数

expression

返回值类型为 xf_err_t 的表达式。 如果 expression 不为 XF_OK, 则调用 XF_CHECK_ERROR_HANDLER.

在文件 xf_check.h 第 182 行定义.