src/testutils/testoptions.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015, 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 /*! \libinternal \file
  36  * \brief
  37  * Functions for accessing test command-line options.
  38  *
  39  * Functions in this header allow accessing command-line options passed to the
  40  * test executable from tests.  This can be used to, e.g., enable additional
  41  * output for debugging purposes.
  42  *
  43  * \author Teemu Murtola <teemu.murtola@gmail.com>
  44  * \inlibraryapi
  45  * \ingroup module_testutils
  46  */
  47 #ifndef GMX_TESTUTILS_TESTOPTIONS_H
  48 #define GMX_TESTUTILS_TESTOPTIONS_H
  49
  50 namespace gmx
  51 {
  52
  53 class Options;
  54
  55 namespace test
  56 {
  57
  58 /*! \libinternal \brief
  59  * Provides additional options for the test executable.
  60  *
  61  * Typically not used directly in test code, but through the
  62  * #GMX_TEST_OPTIONS macro.
  63  *
  64  * \inlibraryapi
  65  * \ingroup module_testutils
  66  */
  67 class TestOptionsProvider
  68 {
  69     public:
  70         /*! \brief
  71          * Initializes the options from this provider.
  72          *
  73          * \param   options  The options need to be added here.
  74          */
  75         virtual void initOptions(Options *options) = 0;
  76
  77     protected:
  78         virtual ~TestOptionsProvider() {}
  79 };
  80
  81 /*! \libinternal \brief
  82  * Registers a test option provider with the test framework.
  83  *
  84  * \param[in] name     Name of the options provider (for ordering).
  85  * \param[in] provider The provider to register.
  86  * \throws  std::bad_alloc     if out of memory.
  87  * \throws  tMPI::system_error on mutex failures.
  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(Options *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/options.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 \
 167     { \
 168         public: \
 169             name() \
 170             { \
 171                 ::gmx::test::registerTestOptions(#name, this); \
 172             } \
 173             virtual void initOptions(::gmx::Options *options); \
 174     }; \
 175     \
 176     static name s_ ## name ## Instance; \
 177     \
 178     void name::initOptions(::gmx::Options *options)
 179
 180 } // namespace test
 181 } // namespace gmx
 182
 183 #endif