src/testutils/testoptions.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2019,2020,2021, 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 /*! \internal \file
  36  * \brief
  37  * Implements functions in testoptions.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "testutils/testoptions.h"
  45
  46 #include <list>
  47 #include <mutex>
  48
  49 #include <memory>
  50 #include "gromacs/utility/classhelpers.h"
  51
  52 namespace gmx
  53 {
  54 namespace test
  55 {
  56
  57 namespace
  58 {
  59
  60 /*! \brief
  61  * Singleton registry for test options added with #GMX_TEST_OPTIONS.
  62  *
  63  * \ingroup module_testutils
  64  */
  65 class TestOptionsRegistry
  66 {
  67 public:
  68     //! Returns the singleton instance of this class.
  69     static TestOptionsRegistry& getInstance()
  70     {
  71         static TestOptionsRegistry singleton;
  72         return singleton;
  73     }
  74
  75     //! Adds a provider into the registry.
  76     void add(const char* /*name*/, TestOptionsProvider* provider)
  77     {
  78         std::lock_guard<std::mutex> lock(listMutex_);
  79         providerList_.push_back(provider);
  80     }
  81
  82     //! Initializes the options from all the provides.
  83     void initOptions(IOptionsContainer* options);
  84
  85 private:
  86     TestOptionsRegistry() {}
  87
  88     typedef std::list<TestOptionsProvider*> ProviderList;
  89
  90     std::mutex   listMutex_;
  91     ProviderList providerList_;
  92
  93     GMX_DISALLOW_COPY_AND_ASSIGN(TestOptionsRegistry);
  94 };
  95
  96 void TestOptionsRegistry::initOptions(IOptionsContainer* options)
  97 {
  98     // TODO: Have some deterministic order for the options; now it depends on
  99     // the order in which the global initializers are run.
 100     std::lock_guard<std::mutex>  lock(listMutex_);
 101     ProviderList::const_iterator i;
 102     for (i = providerList_.begin(); i != providerList_.end(); ++i)
 103     {
 104         (*i)->initOptions(options);
 105     }
 106 }
 107
 108 } // namespace
 109
 110 void registerTestOptions(const char* name, TestOptionsProvider* provider)
 111 {
 112     TestOptionsRegistry::getInstance().add(name, provider);
 113 }
 114
 115 void initTestOptions(IOptionsContainer* options)
 116 {
 117     TestOptionsRegistry::getInstance().initOptions(options);
 118 }
 119
 120 } // namespace test
 121 } // namespace gmx