src/testutils/testoptions.cpp

   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 /*! \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 "testoptions.h"
  45
  46 #include <list>
  47
  48 #include "gromacs/utility/classhelpers.h"
  49 #include "gromacs/utility/mutex.h"
  50
  51 namespace gmx
  52 {
  53 namespace test
  54 {
  55
  56 namespace
  57 {
  58
  59 /*! \brief
  60  * Singleton registry for test options added with #GMX_TEST_OPTIONS.
  61  *
  62  * \ingroup module_testutils
  63  */
  64 class TestOptionsRegistry
  65 {
  66     public:
  67         //! Returns the singleton instance of this class.
  68         static TestOptionsRegistry &getInstance()
  69         {
  70             static TestOptionsRegistry singleton;
  71             return singleton;
  72         }
  73
  74         //! Adds a provider into the registry.
  75         void add(const char * /*name*/, TestOptionsProvider *provider)
  76         {
  77             lock_guard<Mutex> lock(listMutex_);
  78             providerList_.push_back(provider);
  79         }
  80
  81         //! Initializes the options from all the provides.
  82         void initOptions(IOptionsContainer *options);
  83
  84     private:
  85         TestOptionsRegistry() {}
  86
  87         typedef std::list<TestOptionsProvider *> ProviderList;
  88
  89         Mutex                   listMutex_;
  90         ProviderList            providerList_;
  91
  92         GMX_DISALLOW_COPY_AND_ASSIGN(TestOptionsRegistry);
  93 };
  94
  95 void TestOptionsRegistry::initOptions(IOptionsContainer *options)
  96 {
  97     // TODO: Have some deterministic order for the options; now it depends on
  98     // the order in which the global initializers are run.
  99     lock_guard<Mutex>             lock(listMutex_);
 100     ProviderList::const_iterator  i;
 101     for (i = providerList_.begin(); i != providerList_.end(); ++i)
 102     {
 103         (*i)->initOptions(options);
 104     }
 105 }
 106
 107 }       // namespace
 108
 109 void registerTestOptions(const char *name, TestOptionsProvider *provider)
 110 {
 111     TestOptionsRegistry::getInstance().add(name, provider);
 112 }
 113
 114 void initTestOptions(IOptionsContainer *options)
 115 {
 116     TestOptionsRegistry::getInstance().initOptions(options);
 117 }
 118
 119 } // namespace test
 120 } // namespace gmx