afw_version.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Version Header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_VERSION_H__
#define __AFW_VERSION_H__
 
#include "afw_common.h" 
 
AFW_BEGIN_DECLARES
 
AFW_DECLARE(unsigned int)
afw_version();
 
AFW_DECLARE(const afw_utf8_t *)
afw_version_string();
 
AFW_DECLARE(const afw_utf8_z_t *)
afw_version_string_z();
 
AFW_DECLARE(const afw_utf8_z_t *)
afw_version_check(unsigned int version);
 
#define AFW_VERSION_CHECK afw_version_check(AFW_VERSION_HEX)
 
#define AFW_VERSION_THROW_ERROR_SUPPLIED_HEX_VERSION_IF_NOT_COMPATIBLE( \
    info, compiled_version, xctx) \
do { \
    const afw_utf8_z_t *msg_z; \
    msg_z = afw_version_check(compiled_version); \
    if (msg_z) { \
        AFW_THROW_ERROR_FZ(general, xctx, \
            "%" AFW_UTF8_FMT " %s", \
            AFW_UTF8_FMT_ARG(info), msg_z); \
    } \
} while (0)
 
#define AFW_VERSION_THROW_ERROR_IF_NOT_COMPATIBLE(id_z, xctx) \
do { \
    const afw_utf8_z_t *msg_z; \
    msg_z = AFW_VERSION_CHECK; \
    if (msg_z) { \
        AFW_THROW_ERROR_FZ(general, xctx, "%s %s", id_z, msg_z); \
    } \
} while (0)
 
#define AFW_VERSION_ABORT_IF_NOT_COMPATIBLE(id_z) \
do { \
    const afw_utf8_z_t *msg_z; \
    msg_z = AFW_VERSION_CHECK; \
    if (msg_z) { \
        fprintf(stderr, "%s %s", id_z, msg_z); \
        abort(); \
    } \
} while (0)
 
AFW_END_DECLARES
 
#endif /* __AFW_VERSION_H__ */