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, 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 "../utility/common.h"
  52 #include "../utility/gmxassert.h"
  53
  54 #include "abstractoption.h"
  55
  56 namespace gmx
  57 {
  58
  59 template <typename T> class ConstArrayRef;
  60
  61 class AbstractOption;
  62 class OptionsAssigner;
  63 class OptionsIterator;
  64
  65 /*! \brief
  66  * Base class for option managers.
  67  *
  68  * This class is used as a marker for all classes that are used with
  69  * Options::addManager().  It doesn't provide any methods, but only supports
  70  * transporting these classes through the Options collection into the
  71  * individual option implementation classes.
  72  *
  73  * The virtual destructor is present to make this class polymorphic, such that
  74  * `dynamic_cast` can be used when retrieving a manager of a certain type for
  75  * the individual options.
  76  *
  77  * \inlibraryapi
  78  * \ingroup module_options
  79  */
  80 class OptionManagerInterface
  81 {
  82     protected:
  83         virtual ~OptionManagerInterface();
  84 };
  85
  86 /*! \brief
  87  * Collection of options.
  88  *
  89  * This class provides a standard interface for implementing input options.
  90  * Standard usage is to write a method that creates an Options that is owned by
  91  * the object, populates it with supported options, and then returns it:
  92  * \code
  93    // <as class attributes>
  94    using gmx::Options;
  95    Options      options("common", "Common Options");
  96    std::string  arg1;
  97    int          arg2;
  98
  99    // <populating>
 100    using gmx::StringOption;
 101    using gmx::IntegerOption;
 102    options.addOption(StringOption("arg1").store(&arg1));
 103    options.addOption(IntegerOption("arg2").store(&arg2));
 104    return &options;
 105    \endcode
 106  * The caller of that method can then use a parser implementation such as
 107  * CommandLineParser to provide values for the options.
 108  *
 109  * Header basicoptions.h provides declarations of several standard
 110  * option types for use with addOption().  Documentation of those classes
 111  * also give more examples of how to define options.
 112  *
 113  * In order to keep the public interface of this class simple and to reduce
 114  * build dependencies on objects that simply provide options, functionality
 115  * to assign values to options is provided by a separate OptionsAssigner class.
 116  * Similarly, functionality for looping over all options (e.g., for writing out
 117  * help) is provided by OptionsIterator.
 118  *
 119  * \inpublicapi
 120  * \ingroup module_options
 121  */
 122 class Options
 123 {
 124     public:
 125         /*! \brief
 126          * Initializes the name and title of an option collection.
 127          *
 128          * \param[in] name  Single-word name.
 129          * \param[in] title Descriptive title.
 130          *
 131          * Copies the input strings.
 132          */
 133         Options(const char *name, const char *title);
 134         ~Options();
 135
 136         //! Returns the short name of the option collection.
 137         const std::string &name() const;
 138         //! Returns the title of the option collection.
 139         const std::string &title() const;
 140         //! Returns the full description of the option collection.
 141         const std::string &description() const;
 142
 143         /*! \brief
 144          * Sets the full description of the option collection.
 145          *
 146          * \param[in] desc  String to set as the description.
 147          *
 148          * This overload is mainly useful if the description is very short.
 149          * Currently this is mostly the case in unit testing.
 150          */
 151         void setDescription(const std::string &desc);
 152         /*! \brief
 153          * Sets the full description of the option collection from string array.
 154          *
 155          * \param[in] descArray  String array to set as the description.
 156          *
 157          * All strings in `descArray` are concatenated to form the description.
 158          * Spaces are inserted between strings if they are missing.
 159          *
 160          * Example usage:
 161          * \code
 162            const char *const desc[] = {
 163                "This is the description",
 164                "for the options"
 165            };
 166
 167            gmx::Options options(NULL, NULL);
 168            options.setDescription(desc);
 169            \endcode
 170          *
 171          * To use this overload, you must also include
 172          * `gromacs/utility/arrayref.h`.
 173          */
 174         void setDescription(const ConstArrayRef<const char *> &descArray);
 175
 176         /*! \brief
 177          * Adds an option manager.
 178          *
 179          * \param    manager Manager to add.
 180          * \throws   std::bad_alloc if out of memory.
 181          *
 182          * Option managers are used by some types of options that require
 183          * interaction between different option instances (e.g., selection
 184          * options), or need to support globally set properties (e.g., a global
 185          * default file prefix).  Option objects can retrieve the pointer to
 186          * their manager when they are created, and the caller can alter the
 187          * behavior of the options through the manager.
 188          * See the individual managers for details.
 189          *
 190          * Caller is responsible for memory management of \p manager.
 191          * The Options object (and its contained options) only stores a
 192          * reference to the object.
 193          *
 194          * This method cannot be called after adding options or subsections.
 195          */
 196         void addManager(OptionManagerInterface *manager);
 197
 198         /*! \brief
 199          * Adds an option collection as a subsection of this collection.
 200          *
 201          * \param[in] section Subsection to add.
 202          *
 203          * The name() field of \p section is used as the name of the
 204          * subsection.  If an attempt is made to add two different subsections
 205          * with the same name, this function asserts.
 206          *
 207          * \p section should not have any options added at the point this
 208          * method is called.
 209          *
 210          * Only a pointer to the provided object is stored.  The caller is
 211          * responsible that the object exists for the lifetime of the
 212          * collection.
 213          * It is not possible to add the same Options object as a subsection to
 214          * several different Options.
 215          * If an attempt is made, the function asserts.
 216          */
 217         void addSubSection(Options *section);
 218         /*! \brief
 219          * Adds a recognized option to the collection.
 220          *
 221          * \param[in] settings Option description.
 222          * \returns   OptionInfo object for the created option (never NULL).
 223          * \throws    APIError if invalid option settings are provided.
 224          *
 225          * This method provides the internal implementation, but in most cases
 226          * the templated method is called from user code.
 227          * See the templated method for more details.
 228          */
 229         OptionInfo *addOption(const AbstractOption &settings);
 230         /*! \brief
 231          * Adds a recognized option to the collection.
 232          *
 233          * \tparam    OptionType Type of the options description object.
 234          * \param[in] settings   Option description.
 235          * \returns   OptionInfo object for the created option (never NULL).
 236          * \throws    APIError if invalid option settings are provided.
 237          *
 238          * The return value is a pointer for more convenient use in callers:
 239          * often callers need to declare the variable that will hold the return
 240          * value in wider scope than would be achieved by declaring it at the
 241          * site where addOption() is called.
 242          * The returned pointer must not be freed.
 243          *
 244          * See \link Options class documentation \endlink for example usage.
 245          *
 246          * \libinternal
 247          * \p OptionType::InfoType must specify a type that derives from
 248          * OptionInfo and matches the type that is returned by
 249          * AbstractOptionStorage::optionInfo() for the storage object that
 250          * corresponds to \p OptionType.
 251          */
 252         template <class OptionType>
 253         typename OptionType::InfoType *addOption(const OptionType &settings)
 254         {
 255             OptionInfo *info
 256                 = addOption(static_cast<const AbstractOption &>(settings));
 257             GMX_ASSERT(info->isType<typename OptionType::InfoType>(),
 258                        "Mismatching option info type declaration and implementation");
 259             return info->toType<typename OptionType::InfoType>();
 260         }
 261
 262         //! Returns true if option \p name is set.
 263         bool isSet(const char *name) const;
 264         /*! \brief
 265          * Notifies the collection that all option values are assigned.
 266          *
 267          * \throws InvalidInputError if invalid user input is detected.
 268          *
 269          * This function should be called after no more option values are
 270          * to be assigned.  Values in storage variables are guaranteed to be
 271          * available only after this call, although in most cases, they are
 272          * available already during assignment.
 273          *
 274          * If invalid option values, e.g., missing required option, is detected
 275          * at this point, this function throws.  The thrown exception contains
 276          * information on all errors detected during the call.
 277          */
 278         void finish();
 279
 280     private:
 281         class Impl;
 282
 283         PrivateImplPointer<Impl> impl_;
 284
 285         //! Needed to be able to extend the interface of this object.
 286         friend class OptionsAssigner;
 287         //! Needed to be able to extend the interface of this object.
 288         friend class OptionsIterator;
 289         //! Needed to be able to extend the interface of this object.
 290         friend class OptionsModifyingIterator;
 291 };
 292
 293 } // namespace gmx
 294
 295 #endif