src/gromacs/utility/gmxassert.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief
  37  * Defines assert macros customized for Gromacs.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_GMXASSERT_H
  44 #define GMX_UTILITY_GMXASSERT_H
  45
  46 #include <boost/current_function.hpp>
  47
  48 #include "basedefinitions.h"
  49
  50 //! \addtogroup module_utility
  51 //! \{
  52
  53 /*! \def GMX_RELEASE_ASSERT
  54  * \brief
  55  * Macro for asserts that should also be present in the release version.
  56  *
  57  * Regardless of NDEBUG, this macro checks \p condition, and if it is not true,
  58  * it calls the assert handler.
  59  *
  60  * Although this macro currently calls abort() if the assertion fails, it
  61  * should only be used in a context where it is safe to throw an exception to
  62  * keep the option open.
  63  */
  64 #ifdef GMX_DISABLE_ASSERTS
  65 #define GMX_RELEASE_ASSERT(condition, msg)
  66 #else
  67 #define GMX_RELEASE_ASSERT(condition, msg) \
  68     ((void) ((condition) ? (void)0 : \
  69              ::gmx::internal::assertHandler(#condition, msg, \
  70                                             BOOST_CURRENT_FUNCTION, __FILE__, __LINE__)))
  71 #endif
  72 /*! \def GMX_ASSERT
  73  * \brief
  74  * Macro for debug asserts.
  75  *
  76  * If NDEBUG is defined, this macro expands to nothing.
  77  * If it is not defined, it will work exactly like ::GMX_RELEASE_ASSERT.
  78  *
  79  * \see ::GMX_RELEASE_ASSERT
  80  */
  81 #ifdef NDEBUG
  82 #define GMX_ASSERT(condition, msg)
  83 #else
  84 #define GMX_ASSERT(condition, msg) GMX_RELEASE_ASSERT(condition, msg)
  85 #endif
  86
  87 //! \}
  88
  89 namespace gmx
  90 {
  91
  92 /*! \cond internal */
  93 namespace internal
  94 {
  95
  96 /*! \brief
  97  * Called when an assert fails.
  98  *
  99  * Should not be called directly, but instead through ::GMX_ASSERT or
 100  * ::GMX_RELEASE_ASSERT.
 101  *
 102  * \ingroup module_utility
 103  */
 104 gmx_noreturn
 105 void assertHandler(const char *condition, const char *msg,
 106                    const char *func, const char *file, int line);
 107
 108 }   // namespace internal
 109 //! \endcond
 110
 111 } // namespace gmx
 112
 113 #endif