common.h

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
#ifndef __COMMON_H__
#define __COMMON_H__
 
#include <stddef.h>
#include <stdint.h>
 
#define CRINIT_PARAM_UNUSED(par) \
    do {                         \
        (void)(par);             \
    } while (0)
 
#define crinitParamCheck(inputParam, cmpShort, cmpLong) \
    ((strncmp(inputParam, cmpShort, sizeof(cmpShort)) == 0) || (strncmp(inputParam, cmpLong, sizeof(cmpLong)) == 0))
 
#define crinitIsAbsPath(path) (((path) != NULL) && ((path)[0] == '/'))
 
#define crinitNumElements(p) (sizeof(p) / sizeof(*(p)))
 
#define crinitNullCheck(errcode, ...)                                                         \
    do {                                                                                      \
        _Pragma("GCC diagnostic push");                                                       \
        _Pragma("GCC diagnostic error \"-Wshadow\"");                                         \
        const void *_macroPtrsToCheck[] = {__VA_ARGS__};                                      \
        for (size_t _macroI = 0; _macroI < crinitNumElements(_macroPtrsToCheck); _macroI++) { \
            if (_macroPtrsToCheck[_macroI] == NULL) {                                         \
                crinitErrPrint("Input parameters must not be NULL.");                         \
                return (errcode);                                                             \
            }                                                                                 \
        }                                                                                     \
        _Pragma("GCC diagnostic pop");                                                        \
    } while (0)
 
// clang-format off
// Rationale: Used version of clang-format does not format _Generic macros correctly. This is a known bug and has been
// fixed very recently. We may remove this exemption once we are on the new clang version as standard.
// See: https://github.com/llvm/llvm-project/issues/18080
#define crinitStrtoGenericInteger(resType, str, endptr, base) \
    _Generic((resType),                                       \
             int : strtol,                                    \
             long : strtol,                                   \
             long long : strtoll,                             \
             unsigned int : strtoul,                          \
             unsigned long : strtoul,                         \
             unsigned long long : strtoull)                   \
             ((str), (endptr), (base))
// clang-format on
 
#define crinitNullify(ptr) \
    do {                   \
        free(ptr);         \
        (ptr) = NULL;      \
    } while (0)
 
int crinitBinReadAll(uint8_t *buf, size_t n, const char *path);
 
#endif /* __COMMON_H__ */