src/gromacs/utility/gmxassert.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \file
  32  * \brief
  33  * Defines assert macros customized for Gromacs.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inpublicapi
  37  * \ingroup module_utility
  38  */
  39 #ifndef GMX_UTILITY_GMXASSERT_H
  40 #define GMX_UTILITY_GMXASSERT_H
  41
  42 #include <boost/current_function.hpp>
  43 #include <boost/exception/detail/attribute_noreturn.hpp>
  44
  45 /*! \addtopublicapi
  46  * \{
  47  */
  48
  49 /*! \brief
  50  * Macro for asserts that should also be present in the release version.
  51  *
  52  * Regardless of NDEBUG, this macro checks \p condition, and if it is not true,
  53  * it calls the assert handler.
  54  *
  55  * Although this macro currently calls abort() if the assertion fails, it
  56  * should only be used in a context where it is safe to throw an exception to
  57  * keep the option open.
  58  */
  59 #define GMX_RELEASE_ASSERT(condition, msg) \
  60     ((void) ((condition) ? (void)0 : \
  61         ::gmx::internal::assertHandler(#condition, msg, \
  62             BOOST_CURRENT_FUNCTION, __FILE__, __LINE__)))
  63 /*! \def GMX_ASSERT
  64  * \brief
  65  * Macro for debug asserts.
  66  *
  67  * If NDEBUG is defined, this macro expands to nothing.
  68  * If it is not defined, it will work exactly like ::GMX_RELEASE_ASSERT.
  69  *
  70  * \see ::GMX_RELEASE_ASSERT
  71  */
  72 #ifdef NDEBUG
  73 #define GMX_ASSERT(condition, msg)
  74 #else
  75 #define GMX_ASSERT(condition, msg) GMX_RELEASE_ASSERT(condition, msg)
  76 #endif
  77
  78 /*!\}*/
  79
  80 namespace gmx
  81 {
  82
  83 /*! \cond internal */
  84 namespace internal
  85 {
  86
  87 /*! \brief
  88  * Called when an assert fails.
  89  *
  90  * Should not be called directly, but instead through ::GMX_ASSERT or
  91  * ::GMX_RELEASE_ASSERT.
  92  *
  93  * \ingroup module_utility
  94  */
  95 BOOST_ATTRIBUTE_NORETURN
  96 void assertHandler(const char *condition, const char *msg,
  97                    const char *func, const char *file, int line);
  98
  99 } // namespace internal
 100 //! \endcond
 101
 102 } // namespace gmx
 103
 104 #endif