clipm_testlib_defines.h

Go to the documentation of this file.

/*********************************************************************
 * E.S.O. - VLT project
 *
 * "@(#) $Id: clipm_testlib_defines.h 262789 2014-12-10 11:06:45Z cgarcia $"
 *
 * Macro definitions for clipm tests
 *
 * who       when        what
 * --------  ----------  ----------------------------------------------
 * hlorch    2006-05-04  created
 */

#ifndef CLIPM_TESTLIB_DEFINES_H
#define CLIPM_TESTLIB_DEFINES_H

/*-----------------------------------------------------------------------------
    Includes
 -----------------------------------------------------------------------------*/
 
#include <cpl.h>
#include <clipm_priv_error.h>
#include <clipm_compatibility_cpl.h>
#include <string.h>

/*-----------------------------------------------------------------------------
    Defines
 -----------------------------------------------------------------------------*/

#if (defined HAVE_DECL___FUNC__ && !HAVE_DECL___FUNC__)

#ifndef __func__
#ifdef __FUNC__
#define __func__ __FUNC__
#else
#define __func__ "unspecified func"
#endif
#endif

#endif

#define __file__ __FILE__

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#define     clipm_testlib_image_save_if_verbose_nr(image, descriptor, nr) \
do { \
    _clipm_testlib_image_save_if_verbose(   image, \
                                            __func__, \
                                            descriptor, \
                                            nr); \
} while (0)

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#define     clipm_testlib_image_save_if_verbose(image, descriptor) \
do { \
    _clipm_testlib_image_save_if_verbose(   image, \
                                            __func__, \
                                            descriptor, \
                                            -1); \
} while (0)

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#define     CLIPM_TRY_TESTLIB_ASSERT(       CONDITION) \
do { \
    if (!(CONDITION)) \
    { \
        clipm_testlib_msg_error( \
                "Not fulfilling condition \"%s\"", #CONDITION); \
        CLIPM_TRY_EXIT_WITH_ERROR(          CPL_ERROR_ILLEGAL_OUTPUT); \
    } \
    else \
    { \
        cpl_msg_indent_more(); \
        clipm_testlib_msg_debug("Assert: "#CONDITION); \
        cpl_msg_indent_less(); \
    } \
} while (0)

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#define     CLIPM_TRY_TESTLIB_ASSERT_ZERO(  VALUE, \
                                            TOLERANCE) \
do { \
    double  val, \
            tol; \
    val = (double)(VALUE); \
    tol = (double)(TOLERANCE); \
    if (!(fabs(val) <= tol)) \
    { \
        if (tol == 0.0) \
            clipm_testlib_msg_error( \
                "Not fulfilling condition \"fabs(%s) == %s\"", \
                                            #VALUE, \
                                            #TOLERANCE); \
        else \
            clipm_testlib_msg_error( \
                "Not fulfilling condition \"fabs(%s) < %s\"", \
                                            #VALUE, \
                                            #TOLERANCE); \
        clipm_testlib_msg_error( \
                "Residual is %g", val); \
        CLIPM_TRY_EXIT_WITH_ERROR(          CPL_ERROR_ILLEGAL_OUTPUT); \
    } \
    else \
    { \
        cpl_msg_indent_more(); \
        if (tol == 0.0) \
            clipm_testlib_msg_debug(        "Assert: \"%s == %s\"", \
                                            #VALUE, \
                                            #TOLERANCE); \
        else \
            clipm_testlib_msg_debug(        "Assert: \"fabs(%s) <= %s\"", \
                                            #VALUE, \
                                            #TOLERANCE); \
        cpl_msg_indent_less(); \
    } \
} while (0)

/*----------------------------------------------------------------------------*/
/* different messages for different CPL versions are allowed, because it should
 * anyway only be used when there is an error */
#if CLIPM_GET_INSTALLED_CPL_VERSION >= 4
    #define clipm_testlib_expected_message(EXPECTED, GOT_CODE) \
    do { \
        clipm_testlib_msg_error( \
            "-> expected error %d (%s),", \
            EXPECTED, \
            cpl_error_get_message_default(EXPECTED)); \
        clipm_testlib_msg_error( \
            "   got error %d (%s),", \
            GOT_CODE, \
            cpl_error_get_message_default(GOT_CODE)); \
        clipm_testlib_msg_error( \
            "   in %s: line %d", \
            __func__, \
            __LINE__); \
    } while (0)
#else
    #define clipm_testlib_expected_message(EXPECTED, GOT_CODE) \
    do { \
        clipm_testlib_msg_error( \
            "-> expected error %d,", \
            EXPECTED); \
        clipm_testlib_msg_error( \
            "   got error %d,", \
            GOT_CODE); \
        clipm_testlib_msg_error( \
            "   in %s: line %d", \
            __func__, \
            __LINE__); \
    } while (0)
#endif

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#if CLIPM_GET_INSTALLED_CPL_VERSION >= 4
#define     CLIPM_TRY_TESTLIB_CHECK_RETURN_ERROR_AND_RECOVER( \
                                            FUNC, \
                                            CODE, \
                                            OTHER_CONDITION ) \
do { \
    cpl_error_code  error; \
    cpl_errorstate  state; \
    state = cpl_errorstate_get(); \
    clipm_testlib_msg_info("Checking clean abort with error code %d", \
                                            (CODE)); \
    error = FUNC; \
    cpl_msg_indent_more(); \
    if (cpl_errorstate_is_equal(state)) /* FUNC might not be call but value */ \
    { \
        /*clipm_priv_testlib_msg_success();*/ \
        cpl_msg_info(                       __func__, \
                                            "%s\n  in %s()", \
                                            cpl_error_get_message(), \
                                            cpl_error_get_function()); \
    } \
    else \
    { \
        if (error != cpl_error_get_code()) \
            cpl_error_set_message(__func__, CPL_ERROR_ILLEGAL_OUTPUT, \
                                            "return error does not match" \
                                            " error state"); \
        cpl_errorstate_dump(                state, \
                                            CPL_FALSE, \
                                    clipm_testlib_errorstate_dump_one); \
    } \
    cpl_msg_indent_less(); \
    if (error != (CODE)) \
    { \
        clipm_testlib_expected_message(     CODE, error); \
        CLIPM_TRY_CHECK_ERROR_STATE(); \
        CLIPM_TRY_EXIT_WITH_ERROR(          CPL_ERROR_ILLEGAL_OUTPUT); \
    } \
    \
    CLIPM_TRY_TESTLIB_ASSERT(OTHER_CONDITION); \
    \
    CLIPM_ERROR_RECOVER_TRYSTATE(); \
    \
} while (0)
#else
#define     CLIPM_TRY_TESTLIB_CHECK_RETURN_ERROR_AND_RECOVER( \
                                            FUNC, \
                                            CODE, \
                                            OTHER_CONDITION ) \
do { \
    cpl_error_code  error; \
    clipm_testlib_msg_info("Checking clean abort with error code %d", \
                                            (CODE)); \
    error = FUNC; \
    cpl_msg_indent_more(); \
    if (error == CPL_ERROR_NONE && cpl_error_get_code() == CPL_ERROR_NONE) \
        clipm_testlib_msg_info("Successful."); \
    else \
    { \
        clipm_testlib_msg_error(            "\"%s\" in %s", \
                                            cpl_error_get_message(), \
                                            cpl_error_get_where()); \
        if (error != cpl_error_get_code()) \
        { \
            cpl_error_set(__func__, CPL_ERROR_ILLEGAL_OUTPUT); \
            clipm_testlib_msg_error(        "return error does not match" \
                                            " error state"); \
        } \
    } \
    cpl_msg_indent_less(); \
    if (error != (CODE)) \
    { \
        clipm_testlib_expected_message(     CODE, error); \
        CLIPM_TRY_CHECK_ERROR_STATE(); \
        CLIPM_TRY_EXIT_WITH_ERROR(          CPL_ERROR_ILLEGAL_OUTPUT); \
    } \
    \
    CLIPM_TRY_TESTLIB_ASSERT(OTHER_CONDITION); \
    \
    CLIPM_ERROR_RECOVER_TRYSTATE(); \
    \
} while (0)
#endif


/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#define     CLIPM_TRY_TESTLIB_DONT_CHECK(   CODE ) \
    clipm_testlib_msg_info( \
        "Note: check for error code %d not implemented/possible", \
                                            (CODE));

/*----------------------------------------------------------------------------*/
#endif /* CLIPM_TESTLIB_DEFINES_H */