choco_macros.h

Go to the documentation of this file.

 
#ifndef GLCE_ENGINE_BASE_CHOCO_MACROS_H
#define GLCE_ENGINE_BASE_CHOCO_MACROS_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
 
#include "choco_message.h"
 
#ifdef __clang__
  #define NO_COVERAGE __attribute__((no_profile_instrument_function))
#else
  #define NO_COVERAGE
#endif
 
#define KIB ((size_t)(1ULL << 10))
 
#define MIB ((size_t)(1ULL << 20))
 
#define GIB ((size_t)(1ULL << 30))
 
#define IS_POWER_OF_TWO(val_) ( ((size_t)(val_) != 0u) && ( (((size_t)(val_) & ((size_t)(val_) - 1u)) == 0u)))
 
#define IF_ARG_NULL_GOTO_CLEANUP(ptr_, return_variable_, rslt_code_, rslt_str_, function_name_, variable_name_) \
    do { \
        if(NULL == ptr_) { \
            ERROR_MESSAGE("%s(%s) - Argument %s requires a valid pointer.", function_name_, rslt_str_, variable_name_); \
            return_variable_ = rslt_code_; \
            goto cleanup;  \
        } \
    } while(0); \
 
#define IF_ARG_NOT_NULL_GOTO_CLEANUP(ptr_, return_variable_, rslt_code_, rslt_str_, function_name_, variable_name_) \
    do { \
        if(NULL != ptr_) { \
            ERROR_MESSAGE("%s(%s) - Argument %s requires a null pointer.", function_name_, rslt_str_, variable_name_); \
            return_variable_ = rslt_code_; \
            goto cleanup;  \
        } \
    } while(0); \
 
#define IF_ALLOC_FAIL_GOTO_CLEANUP(ptr_, return_variable_, rslt_code_, function_name_, variable_name_) \
    do { \
        if(NULL == ptr_) { \
            ERROR_MESSAGE("%s(NO_MEMORY) - Failed to allocate %s memory.", function_name_, variable_name_); \
            return_variable_ = rslt_code_; \
            goto cleanup;  \
        } \
    } while(0); \
 
#define IF_ARG_FALSE_GOTO_CLEANUP(is_valid_, return_variable_, rslt_code_, rslt_str_, function_name_, variable_name_) \
    do { \
        if(!(is_valid_)) { \
            ERROR_MESSAGE("%s(%s) - Argument %s is not valid.", function_name_, rslt_str_, variable_name_); \
            return_variable_ = rslt_code_; \
            goto cleanup;  \
        } \
    } while(0); \
 
#ifdef __cplusplus
}
#endif
#endif