xf_template_source_detail.c

浏览该文件的文档.

 
/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 须知 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
 
 
/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 须知 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
 
/* ==================== [Includes] ========================================== */
 
#include "xf_template_header_detail.h"
 
// #include <stdio.h>
 
#include "xf_component_template.h"
#include "xf_utils.h"
 
/* ==================== [Defines] =========================================== */
 
#define XF_TEMPLATE_HELP_STR            "xf_template v0.1"
#define XF_TEMPLATE_HELP_STR_SPLICING   "test" XF_TEMPLATE_HELP_STR "abc123"
#define XF_TEMPLATE_DEFINE              (1)
 
/* ==================== [Typedefs] ========================================== */
 
typedef enum _xf_templ_enum_t {
    XF_TEMPL_ENUM_0 = 0x00,         
    XF_TEMPL_ENUM_1,                
    XF_TEMPL_ENUM_2,                
    /* 此处保留一行空行，以区分正常值和最大值 */
    XF_TEMPL_ENUM_MAX,              
    XF_TEMPL_ENUM_DEFAULT = XF_TEMPL_ENUM_1,    
} xf_templ_enum_t;
 
typedef int xf_templ_int_t; 
typedef struct _xf_templ_struct_t {
    xf_templ_int_t num;             
    char *p_str;                    
    union {                         
        uint8_t all;                
        struct {                    
            uint8_t val_u4: 4;      
            uint8_t val_bit4: 1;    
            uint8_t reserved: 3;    
        } bits;  
    } data;
} xf_templ_struct_t;
 
/* ==================== [Static Prototypes] ================================= */
 
static xf_templ_int_t _xf_template_func(xf_templ_struct_t *p_struct, int32_t *p_out);
 
void a_function_of_very_many_parameters(
    uint32_t a_parameter_with_a_very_long_name,
    uint32_t another_parameter_with_a_very_long_name,
    uint32_t a_parameter_with_a_very_long_name_too,
    uint32_t a_parameter_with_a_very_long_name_that_is_really_long
);
 
/* ==================== [Static Variables] ================================== */
 
static const char *const TAG        = "xf_main"; 
static xf_templ_int_t s_data        = 0;    
static xf_templ_struct_t s_struct   = {0};  
static void *p_a_pointer            = NULL; 
/* ==================== [Global Variables] ================================== */
 
int g_xf_templ_global_data1_in_head = 0; 
int g_xf_templ_global_data2_no_in_head = 0; 
/* ==================== [Macros] ============================================ */
 
#define XF_TEMPLATE_MACROS_ADD(_a, _b) ((_a) + (_b))
 
#define XF_TEMPLATE_MACROS_NO_RETURN(_a, _b) \
    do { \
        s_data = (_a) + (_b); \
    } while (0)
 
#define XF_TEMPLATE_MACROS_HAS_RETURN(_x)   \
    ({                                      \
        typeof(_x) __ret = (_x);            \
        __ret = __ret + (_x);               \
        (__ret);                            \
    })
 
/* xf_template 输出接口 */
#ifdef xf_log_printf
#   define XF_TEMPL_PRINTF(_fmt, ...)   xf_log_printf(_fmt, ##__VA_ARGS__)
#else /* !defined(xf_log_printf) */
#   define XF_TEMPL_PRINTF(_fmt, ...)
#endif /* defined(xf_log_printf) */
 
#ifndef UNUSED
#   define UNUSED(_x)                   ((void)(_x))     
#endif
 
/* ==================== [Global Functions] ================================== */
 
void xf_main(void)
{
    /* ↑函数定义首行换行 */
    /* 不要以空行开始函数 */
    xf_templ_int_t ret = 0;
    int32_t val = 0; 
    UNUSED(p_a_pointer); 
    XF_LOGI(TAG, "hello");
 
    if (XF_TEMPLATE_VERSION != XF_TEMPLATE_VERSION_CHECK(1, 0, 0)) {
        XF_TEMPL_PRINTF("error: version check failed\n");
    } else {
        XF_TEMPL_PRINTF("version check: ok\n");
    } 
    XF_TEMPL_PRINTF("XF_TEMPLATE_VERSION: %d\n", (int)XF_TEMPLATE_VERSION);
 
    if ((XF_TEMPLATE_VERSION != XF_TEMPLATE_VERSION_CHECK(1, 0, 0))
            || ((XF_TEMPLATE_VERSION != XF_TEMPLATE_VERSION_CHECK(1, 1, 0))
                && (XF_TEMPLATE_VERSION != XF_TEMPLATE_VERSION_CHECK(1, 2, 0)))) {
        /* 空语句 */
    }
 
    xf_component_func();
    xf_template_another_func();
    xf_template_init();
 
    ret = _xf_template_func(&s_struct, &val);
    if (XF_TEMPL_FAIL == ret) {
        XF_TEMPL_PRINTF("error: ret is XF_TEMPL_FAIL\n");
        return;
    }
 
    XF_TEMPL_PRINTF("ret: %d\n", ret);
    XF_TEMPL_PRINTF("ok\n");
 
    return;
    /* 也不要以空行结束函数 */
}
xf_templ_err_t xf_template_init(void)
{
 
    /* **错误**示例 ↑，不要以空行开始函数 */
    s_struct.num =
        XF_TEMPL_ENUM_2 +
        XF_TEMPLATE_MACROS_ADD(
            g_xf_templ_global_data1_in_head,
            g_xf_templ_global_data2_no_in_head
        );
    XF_TEMPL_PRINTF("xf_template_init: s_struct.num: %d\n", (int)s_struct.num);
    return XF_TEMPL_OK;
    /* **错误**示例 ↓，也不要以空行结束函数 */
 
}
 
/* ==================== [Static Functions] ================================== */
 
static xf_templ_int_t _xf_template_func(xf_templ_struct_t *p_struct, int32_t *p_out)
{
    xf_templ_int_t ret = 0;
    /* 参数检查 */
    if ((NULL == p_struct) || (NULL == p_out) || (p_struct->num >= 100)) {
        XF_TEMPL_PRINTF("参数错误\n");
        goto _xf_template_func_err; 
    }
 
    /* 具体操作 */
    p_struct->p_str                 = XF_TEMPLATE_HELP_STR;
    p_struct->data.all              = 0;
    p_struct->data.bits.val_u4      = 0x0a;
    p_struct->data.bits.val_bit4    = true;
    for (uint8_t i = 0; i < sizeof(XF_TEMPLATE_HELP_STR); i++) {
        ret += p_struct->p_str[i];
    }
    ret += p_struct->data.all;
 
    s_data = ret; 
    *p_out = ret;
 
    /* 返回 */
    return ret;
 
_xf_template_func_err: 
    return XF_TEMPL_FAIL;
}
 
void a_function_of_very_many_parameters(
    uint32_t a_parameter_with_a_very_long_name,
    uint32_t another_parameter_with_a_very_long_name,
    uint32_t a_parameter_with_a_very_long_name_too,
    uint32_t a_parameter_with_a_very_long_name_that_is_really_long
)
{
    UNUSED(a_parameter_with_a_very_long_name);
    UNUSED(another_parameter_with_a_very_long_name);
    UNUSED(a_parameter_with_a_very_long_name_too);
    UNUSED(a_parameter_with_a_very_long_name_that_is_really_long);
}
 
/* 为了消除警告，文件末尾(↓)通常带一个换行 */