src/gromacs/options/abstractsection.h

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