assert_pp.h

Go to the documentation of this file.

/*
 * assert_pp.h
 *
 * Copyright (c) 2003 The University of Utah and the Flux Group.
 * All rights reserved.
 *
 * This file is licensed under the terms of the GNU Public License.  
 * See the file "license.terms" for restrictions on redistribution 
 * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 */

/**
 * @file assert_pp.h
 *
 * Provides require/ensure macros for testing preconditions and
 * postconditions.
 */

#ifndef _assert_pp_h
#define _assert_pp_h

#include <stdlib.h>

#if !defined(DEBUG)
#define NO_PRECONDITIONS
#define NO_POSTCONDITIONS
#endif

#if !defined(NO_POSTCONDITIONS) || !defined(NO_PRECONDITIONS)
#if defined(__GNUC__)
/**
 * The 'noreturn' attribute for this compiler.
 */
#define ASSERT_FUNCATTR_NORETURN __attribute__((__noreturn__))
#else
/**
 * Empty 'noreturn' attribute for unsupported compilers.
 */
#define ASSERT_FUNCATTR_NORETURN
#endif
#ifdef __cplusplus
extern "C" {
#endif
/**
 * The routine which prints failure messages and aborts the program.
 * Defined in misc/src/assert_pp.c.
 *
 * @param file The file name containing the condition.
 * @param line The line number containing the condition.
 * @param func The name of the function containing the condition.
 * @param type Type of condition.
 * @param expr The stringified expression that failed.
 * @return Doesn't.
 */
extern int pp_failed(char *file, unsigned int line,
                     const char* func, char *type, char *expr) 
        ASSERT_FUNCATTR_NORETURN;
#ifdef __cplusplus
}
#endif
#endif

#ifndef NO_PRECONDITIONS
/**
 * Wrapper for declarations that need to be conditionally compiled because they
 * are only used by a precondition.
 *
 * @param decl The declaration to conditionally compile.
 */
#define pp_decl(decl) decl
/**
 * Wrapper for code blocks that need to be conditionally compiled because they
 * are only used by a precondition.
 *
 * @param block The code block to conditionally compile.
 */
#define pp_block(block) block
/**
 * Require an expression to be true.  If the expression turns out to be false,
 * pp_failed is called with the location of this use of require.
 *
 * @see assert
 * @see ensure
 *
 * @param precon The expression to test.
 */
#define require(precon) \
        ((void)((precon) ? 0 : \
                (pp_failed(__FILE__,__LINE__,__PRETTY_FUNCTION__,"precondition",__STRING(precon)))))
#else
#define require(x)
#define pp_decl(x)
#define pp_block(x)
#endif

#ifndef NO_POSTCONDITIONS
/**
 * Ensure an expression to be true.  If the expression turns out to be false,
 * pp_failed is called with the location of this use of ensure.
 *
 * @see assert
 * @see require
 *
 * @param postcon The expression to test.
 */
#define ensure(postcon) \
        ((void)((postcon) ? 0 : \
                (pp_failed(__FILE__,__LINE__,__PRETTY_FUNCTION__,"postcondition",__STRING(postcon)))))
#else
#define ensure(x)
#endif

#endif

---