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,2021, 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 "current_function.h"
  48
  49 //! \addtogroup module_utility
  50 //! \{
  51
  52 /*! \def GMX_RELEASE_ASSERT
  53  * \brief
  54  * Macro for asserts that should also be present in the release version.
  55  *
  56  * Regardless of NDEBUG, this macro checks \p condition, and if it is not true,
  57  * it calls the assert handler.
  58  *
  59  * Although this macro currently calls abort() if the assertion fails, it
  60  * should only be used in a context where it is safe to throw an exception to
  61  * keep the option open.
  62  */
  63 #ifdef GMX_DISABLE_ASSERTS
  64 #    define GMX_RELEASE_ASSERT(condition, msg)
  65 #else
  66 #    ifdef _MSC_VER
  67 #        define GMX_RELEASE_ASSERT(condition, msg)                \
  68             ((void)((condition) ? (void)0                         \
  69                                 : ::gmx::internal::assertHandler( \
  70                                           #condition, msg, GMX_CURRENT_FUNCTION, __FILE__, __LINE__)))
  71 #    else
  72 // Use an "immediately invoked function expression" to allow being
  73 // used in constexpr context with older GCC versions
  74 // https://akrzemi1.wordpress.com/2017/05/18/asserts-in-constexpr-functions/
  75 #        define GMX_RELEASE_ASSERT(condition, msg)                                                         \
  76             ((void)((condition) ? (void)0 : [&]() {                                                        \
  77                 ::gmx::internal::assertHandler(#condition, msg, GMX_CURRENT_FUNCTION, __FILE__, __LINE__); \
  78             }()))
  79 #    endif
  80 #endif
  81 /*! \def GMX_ASSERT
  82  * \brief
  83  * Macro for debug asserts.
  84  *
  85  * If NDEBUG is defined, this macro expands to nothing.
  86  * If it is not defined, it will work exactly like ::GMX_RELEASE_ASSERT.
  87  *
  88  * \see ::GMX_RELEASE_ASSERT
  89  */
  90 #ifdef NDEBUG
  91 #    define GMX_ASSERT(condition, msg) ((void)0)
  92 #else
  93 #    define GMX_ASSERT(condition, msg) GMX_RELEASE_ASSERT(condition, msg)
  94 #endif
  95
  96 //! \}
  97
  98 namespace gmx
  99 {
 100
 101 /*! \cond internal */
 102 namespace internal
 103 {
 104
 105 /*! \brief
 106  * Called when an assert fails.
 107  *
 108  * Should not be called directly, but instead through ::GMX_ASSERT or
 109  * ::GMX_RELEASE_ASSERT.
 110  *
 111  * \ingroup module_utility
 112  */
 113 [[noreturn]] void
 114 assertHandler(const char* condition, const char* msg, const char* func, const char* file, int line);
 115
 116 } // namespace internal
 117 //! \endcond
 118
 119 } // namespace gmx
 120
 121 #endif