src/gromacs/options/abstractsection.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2018, 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 /*! \file
  36  * \brief
  37  * Declares base classes for declaring option sections.
  38  *
  39  * This header defines base classes for option section settings that are used
  40  * with IOptionsContainerWithSections::addSection().  These classes implement
  41  * the "named parameter" idiom for specifying section properties.
  42  *
  43  * \author Teemu Murtola <teemu.murtola@gmail.com>
  44  * \ingroup module_options
  45  */
  46 #ifndef GMX_OPTIONS_ABSTRACTSECTION_H
  47 #define GMX_OPTIONS_ABSTRACTSECTION_H
  48
  49 #include "gromacs/options/ioptionscontainerwithsections.h"
  50 #include "gromacs/options/isectionstorage.h"
  51 #include "gromacs/utility/classhelpers.h"
  52 #include "gromacs/utility/gmxassert.h"
  53
  54 namespace gmx
  55 {
  56
  57 class IOptionSectionStorage;
  58
  59 namespace internal
  60 {
  61 class OptionSectionImpl;
  62 }
  63
  64 /*! \brief
  65  * Base class for specifying option section properties.
  66  *
  67  * \ingroup module_options
  68  */
  69 class AbstractOptionSection
  70 {
  71     protected:
  72         //! \cond libapi
  73         //! Initializes option properties with the given name.
  74         explicit AbstractOptionSection(const char *name) : name_(name) {}
  75         //! Destructor
  76         virtual ~AbstractOptionSection() {}
  77         /*! \brief
  78          * Creates a storage object corresponding to this section.
  79          *
  80          * Similar to AbstractOption::createStorage().
  81          */
  82         virtual IOptionSectionStorage *createStorage() const = 0;
  83         //! \endcond
  84
  85     private:
  86         const char *name_;
  87
  88         friend class internal::OptionSectionImpl;
  89 };
  90
  91 /*! \brief
  92  * Base class for handles to option sections.
  93  *
  94  * This class implements the common functionality for adding options and
  95  * subsections to option sections.
  96  *
  97  * \ingroup module_options
  98  */
  99 class AbstractOptionSectionHandle : public IOptionsContainerWithSections
 100 {
 101     public:
 102         // From IOptionsContainer
 103         //! \copydoc IOptionsContainer::addGroup()
 104         virtual IOptionsContainer &addGroup();
 105
 106     protected:
 107         //! \cond libapi
 108         /*! \brief
 109          * Returns the storage for a particular type of section.
 110          *
 111          * This is intended for use in derived class constructors, where the
 112          * handle needs access to the actual storage.  The handle should know
 113          * the type of storage created for the section type it deals with, so
 114          * the cast should always be successful.
 115          */
 116         template <typename StorageType>
 117         static StorageType *getStorage(internal::OptionSectionImpl *section)
 118         {
 119             IOptionSectionStorage *storage = getStorage(section);
 120             StorageType           *typedStorage
 121                 = dynamic_cast<StorageType *>(storage);
 122             GMX_ASSERT(typedStorage != nullptr, "Mismatching section storage type");
 123             return typedStorage;
 124         }
 125
 126         //! Wraps a given section storage object.
 127         explicit AbstractOptionSectionHandle(internal::OptionSectionImpl *section)
 128             : section_(section)
 129         {
 130         }
 131         //! \endcond
 132
 133     private:
 134         // From IOptionsContainerWithSections
 135         virtual internal::OptionSectionImpl *
 136         addSectionImpl(const AbstractOptionSection &section);
 137         // From IOptionsContainer
 138         virtual OptionInfo *addOptionImpl(const AbstractOption &settings);
 139
 140         /*! \brief
 141          * Implementation helper for the template method.
 142          *
 143          * This allows encapsulating the implementation within the source file.
 144          */
 145         static IOptionSectionStorage *getStorage(internal::OptionSectionImpl *section);
 146
 147         internal::OptionSectionImpl *section_;
 148 };
 149
 150 class AbstractOptionSectionInfo
 151 {
 152     public:
 153         //! Wraps a given section storage object.
 154         explicit AbstractOptionSectionInfo(internal::OptionSectionImpl *section)
 155             : section_(*section)
 156         {
 157         }
 158
 159         //! Returns the name of the section.
 160         const std::string &name() const;
 161
 162         //! Returns the wrapped section storage object.
 163         internal::OptionSectionImpl       &section() { return section_; }
 164         //! Returns the wrapped section storage object.
 165         const internal::OptionSectionImpl &section() const { return section_; }
 166
 167     private:
 168         internal::OptionSectionImpl &section_;
 169
 170         GMX_DISALLOW_COPY_AND_ASSIGN(AbstractOptionSectionInfo);
 171 };
 172
 173 } // namespace gmx
 174
 175 #endif