src/gromacs/options/options-impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,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  * Declares private implementation class for gmx::Options.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #ifndef GMX_OPTIONS_OPTIONS_IMPL_H
  43 #define GMX_OPTIONS_OPTIONS_IMPL_H
  44
  45 #include <list>
  46 #include <map>
  47 #include <string>
  48 #include <vector>
  49
  50 #include "gromacs/options/abstractoption.h"
  51 #include "gromacs/options/optionmanagercontainer.h"
  52 #include "gromacs/options/options.h"
  53 #include "gromacs/utility/uniqueptr.h"
  54
  55 namespace gmx
  56 {
  57
  58 class AbstractOptionStorage;
  59
  60 namespace internal
  61 {
  62
  63 /*! \internal
  64  * \brief
  65  * Private implementation class for Options.
  66  *
  67  * Note that in addition to Options, the OptionsAssigner and OptionsIterator
  68  * classes also directly access this class.
  69  *
  70  * \ingroup module_options
  71  */
  72 class OptionsImpl
  73 {
  74     public:
  75         /*! \internal \brief
  76          * Describes a group of options (see Options::addGroup()).
  77          *
  78          * \ingroup module_options
  79          */
  80         class Group : public IOptionsContainer
  81         {
  82             public:
  83                 //! Convenience typedef for list of options.
  84                 typedef std::vector<AbstractOptionStorage *> OptionList;
  85                 //! Convenience typedef for list of subgroups.
  86                 typedef std::list<Group> SubgroupList;
  87
  88                 //! Creates a group within the given Options.
  89                 explicit Group(OptionsImpl *parent) : parent_(parent) {}
  90
  91                 //! Adds an option subgroup.
  92                 IOptionsContainer &addGroup();
  93                 // From IOptionsContainer
  94                 virtual OptionInfo *addOption(const AbstractOption &settings);
  95
  96                 //! Containing options object.
  97                 OptionsImpl  *parent_;
  98                 /*! \brief
  99                  * List of options, in insertion order.
 100                  *
 101                  * Pointers in this container point to the objects managed by
 102                  * Impl::optionsMap_.
 103                  */
 104                 OptionList    options_;
 105                 //! List of groups, in insertion order.
 106                 SubgroupList  subgroups_;
 107         };
 108
 109         //! Smart pointer for managing an AbstractOptionStorage object.
 110         typedef gmx_unique_ptr<AbstractOptionStorage>::type
 111             AbstractOptionStoragePointer;
 112         //! Convenience type for list of sections.
 113         typedef std::vector<Options *> SubSectionList;
 114         //! Convenience typedef for a map that contains all the options.
 115         typedef std::map<std::string, AbstractOptionStoragePointer> OptionMap;
 116
 117         //! Sets the name and title.
 118         OptionsImpl(const char *name, const char *title);
 119
 120         /*! \brief
 121          * Finds a subsection by name.
 122          *
 123          * \param[in] name  Name to search for.
 124          * \returns Pointer to the found subsection, or NULL if not found.
 125          *
 126          * Does not throw.
 127          */
 128         Options *findSubSection(const char *name) const;
 129         /*! \brief
 130          * Finds an option by name.
 131          *
 132          * \param[in] name  Name to search for.
 133          * \returns Pointer to the found option, or NULL if not found.
 134          *
 135          * Does not throw.
 136          */
 137         AbstractOptionStorage *findOption(const char *name) const;
 138
 139         /*! \brief
 140          * Calls AbstractOptionStorage::startSource() for all options,
 141          * including subsections.
 142          *
 143          * Does not throw.
 144          */
 145         void startSource();
 146
 147         //! Name for the Options object.
 148         std::string             name_;
 149         /*! \brief
 150          * Option managers set for this collection.
 151          *
 152          * This is non-empty only for the top-level Options object.
 153          */
 154         OptionManagerContainer  managers_;
 155         /*! \brief
 156          * Group that contains all options (and subgroups).
 157          *
 158          * This is used to store the insertion order of options.
 159          */
 160         Group                   rootGroup_;
 161         //! Map from option names to options; owns the option storage objects.
 162         OptionMap               optionMap_;
 163         /*! \brief
 164          * List of subsections, in insertion order.
 165          *
 166          * This container contains only references to external objects; memory
 167          * management is performed elsewhere.
 168          */
 169         SubSectionList          subSections_;
 170         //! Options object that contains this object as a subsection, or NULL.
 171         Options                *parent_;
 172 };
 173
 174 } // namespace internal
 175
 176 } // namespace gmx
 177
 178 #endif