src/gromacs/utility/classhelpers.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
   5  * Copyright (c) 2018,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  * Declares common utility classes and macros.
  39  *
  40  * This header contains helpers used to implement classes in the library.
  41  * It is installed, because the helpers are used in installed headers, but
  42  * typically users of the library should not need to be aware of these helpers.
  43  *
  44  * \author Teemu Murtola <teemu.murtola@gmail.com>
  45  * \inlibraryapi
  46  * \ingroup module_utility
  47  */
  48 #ifndef GMX_UTILITY_CLASSHELPERS_H
  49 #define GMX_UTILITY_CLASSHELPERS_H
  50
  51 namespace gmx
  52 {
  53
  54 #ifdef DOXYGEN
  55 /*! \brief
  56  * Macro to declare a class non-copyable and non-assignable.
  57  *
  58  * For consistency, should appear last in the class declaration.
  59  *
  60  * \ingroup module_utility
  61  */
  62 #    define GMX_DISALLOW_COPY_AND_ASSIGN(ClassName)
  63 #else
  64 #    define GMX_DISALLOW_COPY_AND_ASSIGN(ClassName)      \
  65         ClassName& operator=(const ClassName&) = delete; \
  66         ClassName(const ClassName&)            = delete
  67 #endif
  68 #ifdef DOXYGEN
  69 /*! \brief
  70  * Macro to declare a class non-copyable, non-movable, non-copy-assignable and
  71  * non-move-assignable.
  72  *
  73  * For consistency, should appear last in the class declaration.
  74  *
  75  * \ingroup module_utility
  76  */
  77 #    define GMX_DISALLOW_COPY_MOVE_AND_ASSIGN(ClassName)
  78 #else
  79 #    define GMX_DISALLOW_COPY_MOVE_AND_ASSIGN(ClassName)                                                            \
  80         ClassName& operator=(const ClassName&) = delete;                                                            \
  81         ClassName(const ClassName&)            = delete;                                                            \
  82         ClassName& operator=(ClassName&&) = delete; /* NOLINT(misc-macro-parentheses,bugprone-macro-parentheses) */ \
  83         ClassName(ClassName&&) = delete /* NOLINT(misc-macro-parentheses,bugprone-macro-parentheses) */
  84 #endif
  85 /*! \brief
  86  * Macro to declare a class non-assignable.
  87  *
  88  * For consistency, should appear last in the class declaration.
  89  *
  90  * \ingroup module_utility
  91  */
  92 #define GMX_DISALLOW_ASSIGN(ClassName) ClassName& operator=(const ClassName&) = delete
  93
  94 // clang-format off
  95 #ifdef DOXYGEN
  96 /*! \brief
  97  * Macro to declare default constructors
  98  *
  99  * Intended for copyable interfaces or bases classes which require to create custom
 100  * destructor (e.g. protected or virtual) but need the default constructors.
 101  *
 102  * \ingroup module_utility
 103  */
 104 #    define GMX_DEFAULT_CONSTRUCTORS(ClassName)
 105 #else
 106 #    define GMX_DEFAULT_CONSTRUCTORS(ClassName)                                                                           \
 107         ClassName() = default;                                                                                            \
 108         ClassName& operator=(const ClassName&) = default; /* NOLINT(misc-macro-parentheses,bugprone-macro-parentheses) */ \
 109         ClassName(const ClassName&) = default;                                                                            \
 110         ClassName& operator=(ClassName&&) = default; /* NOLINT(misc-macro-parentheses,bugprone-macro-parentheses) */      \
 111         ClassName(ClassName&&) = default /* NOLINT(misc-macro-parentheses,bugprone-macro-parentheses) */
 112 #endif
 113 //clang-format on
 114
 115 } // namespace gmx
 116
 117 #endif