common.h

Go to the documentation of this file.

#ifndef __COMMON_HEADER_H__
#define __COMMON_HEADER_H__

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
#include <stddef.h>
#include <string.h>

#define CT_ASSERT(e) extern char (*CT_ASSERT(void)) [sizeof(char[1 - 2*!(e)])]

#define NELEMS(x) (sizeof(x) / sizeof(x[0]))

#define LOG_ERR(fmt, ...) \
do { \
    printf("(%s:%u) ERROR: " fmt "\n", __FILE__, __LINE__, ##__VA_ARGS__); \
} while (0)

#define VALIDATE_VTABLE_FN(obj_h, private_h, vtable, fn, rc) \
do { \
    if (NULL == obj_h) { \
        LOG_ERR("Invalid input, " #obj_h "(%p)", obj_h); \
        rc = MY_RC_E_EINVAL;  \
        break; \
    } \
\
    if (NULL == obj_h->private_h) { \
        LOG_ERR("Invalid input, " #obj_h "(%p) " #private_h "(%p)", obj_h, \
                obj_h->private_h); \
        rc = MY_RC_E_EINVAL;  \
        break; \
    } \
\
    if (NULL == obj_h->private_h->vtable) { \
        LOG_ERR("Invalid input, " #obj_h "(%p) " #private_h "(%p) " #vtable \
                "(%p)", obj_h, obj_h->private_h, obj_h->private_h->vtable); \
        rc = MY_RC_E_EINVAL;  \
        break; \
    } \
\
    if (NULL == obj_h->private_h->vtable->fn) { \
        LOG_ERR("Invalid input, " #obj_h "(%p) " #private_h "(%p) " #vtable \
                "(%p) " #fn "(%p)",  obj_h, obj_h->private_h, \
                obj_h->private_h->vtable, obj_h->private_h->vtable->fn); \
        rc = MY_RC_E_EINVAL;  \
        break; \
    } \
} while (0)

#define INHERIT_VTABLE_FN(parent_vtable, child_vtable, fn, do_null_check, rc) \
do { \
    if (NULL == child_vtable->fn) { \
        child_vtable->fn = parent_vtable->fn; \
        if (do_null_check && (NULL == child_vtable->fn)) { \
            LOG_ERR("Invalid input, " #fn "(%p)", child_vtable->fn); \
            rc = MY_RC_E_EINVAL; \
            goto err_exit; \
        } \
    } \
} while (0)

typedef enum my_rc_e_ {
    MY_RC_E_INVALID,
    MY_RC_E_SUCCESS,
    MY_RC_E_EINVAL,
    MY_RC_E_ENOMEM,
    MY_RC_E_MAX,
} my_rc_e;

/* APIs below are documented in their implementation file */

extern bool
my_rc_e_is_notok(my_rc_e rc);

extern bool
my_rc_e_is_ok(my_rc_e rc);

extern bool
my_rc_e_is_valid(my_rc_e rc);

extern const char *
my_rc_e_get_string(my_rc_e rc);

#endif