src/gromacs/options/options.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,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 /*! \file
  36  * \brief
  37  * Declares gmx::Options.
  38  *
  39  * Together with basicoptions.h, this header forms the part of the public
  40  * API that most classes will use to provide options.
  41  *
  42  * \author Teemu Murtola <teemu.murtola@gmail.com>
  43  * \inpublicapi
  44  * \ingroup module_options
  45  */
  46 #ifndef GMX_OPTIONS_OPTIONS_H
  47 #define GMX_OPTIONS_OPTIONS_H
  48
  49 #include <string>
  50
  51 #include "gromacs/options/ioptionscontainer.h"
  52 #include "gromacs/utility/classhelpers.h"
  53
  54 namespace gmx
  55 {
  56
  57 class AbstractOption;
  58 class OptionsAssigner;
  59 class OptionsIterator;
  60
  61 namespace internal
  62 {
  63 class OptionsImpl;
  64 }
  65
  66 /*! \brief
  67  * Base class for option managers.
  68  *
  69  * This class is used as a marker for all classes that are used with
  70  * Options::addManager().  It doesn't provide any methods, but only supports
  71  * transporting these classes through the Options collection into the
  72  * individual option implementation classes.
  73  *
  74  * The virtual destructor is present to make this class polymorphic, such that
  75  * `dynamic_cast` can be used when retrieving a manager of a certain type for
  76  * the individual options.
  77  *
  78  * \inlibraryapi
  79  * \ingroup module_options
  80  */
  81 class IOptionManager
  82 {
  83     protected:
  84         virtual ~IOptionManager();
  85 };
  86
  87 /*! \brief
  88  * Collection of options.
  89  *
  90  * See \ref module_options for an overview of how the options work.
  91  * The IOptionsContainer interface documents how to add options.
  92  *
  93  * In order to keep the public interface of this class simple, functionality
  94  * to assign values to options is provided by a separate OptionsAssigner class.
  95  * Similarly, functionality for looping over all options (e.g., for writing out
  96  * help) is provided by OptionsIterator.
  97  *
  98  * \inpublicapi
  99  * \ingroup module_options
 100  */
 101 class Options : public IOptionsContainer
 102 {
 103     public:
 104         /*! \brief
 105          * Initializes the name and title of an option collection.
 106          *
 107          * \param[in] name  Single-word name.
 108          * \param[in] title Descriptive title.
 109          *
 110          * Copies the input strings.
 111          */
 112         Options(const char *name, const char *title);
 113         ~Options();
 114
 115         //! Returns the short name of the option collection.
 116         const std::string &name() const;
 117
 118         /*! \brief
 119          * Adds an option manager.
 120          *
 121          * \param    manager Manager to add.
 122          * \throws   std::bad_alloc if out of memory.
 123          *
 124          * Option managers are used by some types of options that require
 125          * interaction between different option instances (e.g., selection
 126          * options), or need to support globally set properties (e.g., a global
 127          * default file prefix).  Option objects can retrieve the pointer to
 128          * their manager when they are created, and the caller can alter the
 129          * behavior of the options through the manager.
 130          * See the individual managers for details.
 131          *
 132          * Caller is responsible for memory management of \p manager.
 133          * The Options object (and its contained options) only stores a
 134          * reference to the object.
 135          *
 136          * This method cannot be called after adding options or subsections.
 137          */
 138         void addManager(IOptionManager *manager);
 139
 140         /*! \brief
 141          * Adds an option collection as a subsection of this collection.
 142          *
 143          * \param[in] section Subsection to add.
 144          *
 145          * The name() field of \p section is used as the name of the
 146          * subsection.  If an attempt is made to add two different subsections
 147          * with the same name, this function asserts.
 148          *
 149          * \p section should not have any options added at the point this
 150          * method is called.
 151          *
 152          * Only a pointer to the provided object is stored.  The caller is
 153          * responsible that the object exists for the lifetime of the
 154          * collection.
 155          * It is not possible to add the same Options object as a subsection to
 156          * several different Options.
 157          * If an attempt is made, the function asserts.
 158          */
 159         void addSubSection(Options *section);
 160
 161         /*! \brief
 162          * Creates a subgroup of options within the current options.
 163          *
 164          * To add options to the group, use the returned interface.
 165          *
 166          * Currently, this is only used to influence the order of options:
 167          * all options in a group appear before options in a group added after
 168          * it, no matter in which order the options are added to the groups.
 169          * In the future, the groups could also be used to influence the help
 170          * output.
 171          */
 172         IOptionsContainer &addGroup();
 173
 174         // From IOptionsContainer
 175         virtual OptionInfo *addOption(const AbstractOption &settings);
 176         using IOptionsContainer::addOption;
 177
 178         /*! \brief
 179          * Notifies the collection that all option values are assigned.
 180          *
 181          * \throws InvalidInputError if invalid user input is detected.
 182          *
 183          * This function should be called after no more option values are
 184          * to be assigned.  Values in storage variables are guaranteed to be
 185          * available only after this call, although in most cases, they are
 186          * available already during assignment.
 187          *
 188          * If invalid option values, e.g., missing required option, is detected
 189          * at this point, this function throws.  The thrown exception contains
 190          * information on all errors detected during the call.
 191          */
 192         void finish();
 193
 194     private:
 195         PrivateImplPointer<internal::OptionsImpl> impl_;
 196
 197         //! Needed for the implementation to access subsections.
 198         friend class internal::OptionsImpl;
 199         //! Needed to be able to extend the interface of this object.
 200         friend class OptionsAssigner;
 201         //! Needed to be able to extend the interface of this object.
 202         friend class OptionsIterator;
 203         //! Needed to be able to extend the interface of this object.
 204         friend class OptionsModifyingIterator;
 205 };
 206
 207 } // namespace gmx
 208
 209 #endif