src/testutils/include/testutils/testoptions.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2018 by 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 /*! \libinternal \file
  37  * \brief
  38  * Functions for accessing test command-line options.
  39  *
  40  * Functions in this header allow accessing command-line options passed to the
  41  * test executable from tests.  This can be used to, e.g., enable additional
  42  * output for debugging purposes.
  43  *
  44  * \author Teemu Murtola <teemu.murtola@gmail.com>
  45  * \inlibraryapi
  46  * \ingroup module_testutils
  47  */
  48 #ifndef GMX_TESTUTILS_TESTOPTIONS_H
  49 #define GMX_TESTUTILS_TESTOPTIONS_H
  50
  51 namespace gmx
  52 {
  53
  54 class IOptionsContainer;
  55
  56 namespace test
  57 {
  58
  59 /*! \libinternal \brief
  60  * Provides additional options for the test executable.
  61  *
  62  * Typically not used directly in test code, but through the
  63  * #GMX_TEST_OPTIONS macro.
  64  *
  65  * \inlibraryapi
  66  * \ingroup module_testutils
  67  */
  68 class TestOptionsProvider
  69 {
  70 public:
  71     /*! \brief
  72      * Initializes the options from this provider.
  73      *
  74      * \param   options  The options need to be added here.
  75      */
  76     virtual void initOptions(IOptionsContainer* options) = 0;
  77
  78 protected:
  79     virtual ~TestOptionsProvider() {}
  80 };
  81
  82 /*! \libinternal \brief
  83  * Registers a test option provider with the test framework.
  84  *
  85  * \param[in] name     Name of the options provider (for ordering).
  86  * \param[in] provider The provider to register.
  87  * \throws  std::bad_alloc     if out of memory.
  88  *
  89  * Typically not used directly in test code, but through the
  90  * #GMX_TEST_OPTIONS macro.
  91  *
  92  * This gets called from constructors for global variables, so ideally
  93  * it would not throw to avoid unhandled exceptions.  But since this
  94  * is only test code, it is not worth the effort to try to remove those
  95  * rare exceptions (mutex failures and out-of-memory from STL).
  96  *
  97  * \ingroup module_testutils
  98  */
  99 void registerTestOptions(const char* name, TestOptionsProvider* provider);
 100 /*! \libinternal \brief
 101  * Initializes the options from all registered test providers.
 102  *
 103  * \param   options  The options are added here.
 104  *
 105  * This is called automatically by initTestUtils().
 106  *
 107  * \ingroup module_testutils
 108  */
 109 void initTestOptions(IOptionsContainer* options);
 110
 111 // Uncrustify screws up the indentation for the example otherwise.
 112 /* *INDENT-OFF* */
 113 /*! \libinternal \brief
 114  * Macro to add additional command-line options for the test binary.
 115  *
 116  * \param  name    Unique name for the set of options.
 117  * \param  options Placeholder name for an gmx::Options object for adding options.
 118  *
 119  * The macro should be followed by a block that adds the desired command-line
 120  * options to `options` using gmx::Options::addOption().  \ref module_options
 121  * provides an overview of the options machinery.
 122  *
 123  * `name` must be unique within the executable to which the options are added.
 124  * If the macro is within an unnamed namespace, then it is sufficient that it
 125  * is unique within the file.
 126  *
 127  * Typical usage:
 128  * \code
 129    #include "gromacs/options/basicoptions.h"
 130    #include "gromacs/options/ioptionscontainer.h"
 131
 132    #include "testutils/testoptions.h"
 133
 134    namespace gmx
 135    {
 136    namespace
 137    {
 138
 139    bool g_optionValue = false;
 140
 141    //! \cond
 142    GMX_TEST_OPTIONS(MyTestOptions, options)
 143    {
 144        options->addOption(BooleanOption("flag").store(&g_optionValue)
 145                               .description("My description"));
 146    }
 147    //! \endcond
 148
 149    } // namespace
 150    } // namespace gmx
 151    \endcode
 152  *
 153  * \c \\cond and \c \\endcond statements are necessary around the macro to avoid
 154  * Doxygen warnings.
 155  *
 156  * One macro invocation per an added option, with more of the implementation
 157  * details hidden inside the macro, could be nicer.  But that requires more
 158  * elaborate macro machinery, so it is probably not worth the effort and
 159  * complexity.
 160  *
 161  * \ingroup module_testutils
 162  * \hideinitializer
 163  */
 164 /* *INDENT-ON* */
 165 #define GMX_TEST_OPTIONS(name, options)                                                                                \
 166     class name : public ::gmx::test::TestOptionsProvider /*NOLINT(misc-macro-parentheses,bugprone-macro-parentheses)*/ \
 167     {                                                                                                                  \
 168     public:                                                                                                            \
 169         name() { ::gmx::test::registerTestOptions(#name, this); }                                                      \
 170         void initOptions(::gmx::IOptionsContainer*(options)) override;                                                 \
 171     };                                                                                                                 \
 172                                                                                                                        \
 173     static gmx_unused name s_##name##Instance;                                                                         \
 174                                                                                                                        \
 175     void name::initOptions(::gmx::IOptionsContainer* options) //NOLINT(misc-macro-parentheses,bugprone-macro-parentheses)
 176
 177 } // namespace test
 178 } // namespace gmx
 179
 180 #endif