api/legacy/include/gromacs/utility/gmxassert.h

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