src/gromacs/options/abstractoption.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013, 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  * Defines gmx::AbstractOption, gmx::OptionTemplate and gmx::OptionInfo.
  38  *
  39  * This header defines base classes for option settings that are used with
  40  * Options::addOption().  These classes implement the "named parameter"
  41  * idiom for specifying option properties.
  42  *
  43  * These classes also take care of creating and setting up the actual option
  44  * objects.
  45  *
  46  * This header is needed directly only when implementing new option types,
  47  * but methods of OptionTemplate are visible even to the normal user through
  48  * its subclasses.
  49  *
  50  * \author Teemu Murtola <teemu.murtola@gmail.com>
  51  * \inlibraryapi
  52  * \ingroup module_options
  53  */
  54 #ifndef GMX_OPTIONS_ABSTRACTOPTION_H
  55 #define GMX_OPTIONS_ABSTRACTOPTION_H
  56
  57 #include <string>
  58 #include <vector>
  59
  60 #include "../utility/common.h"
  61 #include "../utility/uniqueptr.h"
  62
  63 #include "optionflags.h"
  64
  65 namespace gmx
  66 {
  67
  68 class AbstractOptionStorage;
  69 template <typename T> class OptionStorageTemplate;
  70 class Options;
  71
  72 //! Smart pointer for managing an AbstractOptionStorage object.
  73 typedef gmx_unique_ptr<AbstractOptionStorage>::type
  74     AbstractOptionStoragePointer;
  75
  76 /*! \brief
  77  * Abstract base class for specifying option properties.
  78  *
  79  * Concrete classes should normally not derive directly from this class,
  80  * but from OptionTemplate instead.  Classes derived from this class
  81  * are mainly designed to implement the "named parameter" idiom.  For
  82  * efficiency and clarity, these classes should only store values provided to
  83  * them.  All error checking and memory management should be postponed to the
  84  * point when the actual option is created.
  85  *
  86  * Subclasses should override createStorage() to create the correct type
  87  * of storage object.  If they use their own info type derived from OptionInfo,
  88  * they should also have a public typedef \c InfoType that specifies that
  89  * info type.  This is required for Options::addOption() to return the correct
  90  * info type.
  91  *
  92  * \ingroup module_options
  93  */
  94 class AbstractOption
  95 {
  96     public:
  97         // Virtual only for completeness, in normal use should not be needed.
  98         virtual ~AbstractOption() { }
  99
 100     protected:
 101         /*! \cond libapi */
 102         //! Initializes the name and default values for an option.
 103         explicit AbstractOption(const char *name)
 104             : minValueCount_(1), maxValueCount_(1),
 105               name_(name), descr_(NULL)
 106         { }
 107
 108         /*! \brief
 109          * Creates a default storage object for the option.
 110          *
 111          * \returns The created storage object.
 112          * \throws  APIError if invalid option settings have been provided.
 113          *
 114          * This method is called by Options::addOption() when initializing an
 115          * option from the settings.
 116          *
 117          * Derived classes should implement the method to create an actual
 118          * storage object and populate it with correct values.
 119          * They should also throw APIError if they detect problems.
 120          *
 121          * Should only be called by Options::addOption().
 122          */
 123         virtual AbstractOptionStoragePointer createStorage() const = 0;
 124
 125         //! Sets the description for the option.
 126         void setDescription(const char *descr) { descr_ = descr; }
 127         //! Sets a flag for the option.
 128         void setFlag(OptionFlag flag) { flags_.set(flag); }
 129         //! Clears a flag for the option.
 130         void clearFlag(OptionFlag flag) { flags_.clear(flag); }
 131         //! Sets or clears a flag for the option.
 132         void setFlag(OptionFlag flag, bool bSet) { flags_.set(flag, bSet); }
 133         //! Returns true if the option is vector-valued.
 134         bool isVector() const { return hasFlag(efOption_Vector); }
 135         /*! \brief
 136          * Sets the option to be vector-valued.
 137          *
 138          * This method is provided for convenience to make management of value
 139          * counts easier.  In order to implement a vector-valued option, the
 140          * class derived from AbstractOption should expose a method that calls
 141          * this method, and the storage object derived from
 142          * AbstractOptionStorage should check isVector().
 143          * If only a single value is provided, the storage object should fill
 144          * the whole vector with that value.
 145          *
 146          * The length of the vector (the value of maxValueCount_) must be
 147          * fixed.  The default length is 3 elements.
 148          */
 149         void setVector()
 150         {
 151             setFlag(efOption_Vector);
 152             minValueCount_ = 1;
 153             if (maxValueCount_ == 1)
 154             {
 155                 maxValueCount_ = 3;
 156             }
 157         }
 158         //! Sets the required number of values for the option.
 159         void setValueCount(int count)
 160         {
 161             if (!hasFlag(efOption_Vector))
 162             {
 163                 minValueCount_ = count;
 164             }
 165             maxValueCount_ = count;
 166         }
 167
 168         //! Minimum number of values required for the option.
 169         int                     minValueCount_;
 170         //! Maximum number of values allowed for the option.
 171         int                     maxValueCount_;
 172         //! \endcond
 173
 174     private:
 175         //! Returns true if a flag has been set.
 176         bool hasFlag(OptionFlag flag) const { return flags_.test(flag); }
 177
 178         const char             *name_;
 179         //! Pointer to description of the option.
 180         const char             *descr_;
 181         OptionFlags             flags_;
 182
 183         /*! \brief
 184          * Needed to initialize an AbstractOptionStorage object from this class
 185          * without otherwise unnecessary accessors.
 186          */
 187         friend class AbstractOptionStorage;
 188         /*! \brief
 189          * Needed to be able to call createStorage().
 190          */
 191         friend class Options;
 192 };
 193
 194 /*! \brief
 195  * Templated base class for constructing concrete option settings classes.
 196  *
 197  * \tparam T Assignable type that stores a single option value.
 198  * \tparam U Type of the derived class.
 199  *
 200  * This template is used as a base class like this:
 201  * \code
 202    class ConcreteOption : public OptionTemplate<int, ConcreteOption>
 203    {
 204  * \endcode
 205  *
 206  * All public functions in this class return \c *this casted to a reference to
 207  * \p U.  They do not throw.
 208  *
 209  * For examples of how to use classes derived from this class, see the class
 210  * documentation for Options.
 211  *
 212  * \inlibraryapi
 213  * \ingroup module_options
 214  */
 215 template <typename T, class U>
 216 class OptionTemplate : public AbstractOption
 217 {
 218     public:
 219         //! Type that stores a single option value.
 220         typedef T ValueType;
 221         //! Alias for the derived class type.
 222         typedef U MyClass;
 223
 224         /*! \brief
 225          * Sets a description for the option.
 226          *
 227          * \param[in] descr Description to set.
 228          *
 229          * String in \p descr is copied when the option is created.
 230          */
 231         MyClass &description(const char *descr)
 232         { setDescription(descr); return me(); }
 233         //! Hides the option from normal help output.
 234         MyClass &hidden(bool bHidden = true)
 235         { setFlag(efOption_Hidden, bHidden); return me(); }
 236         /*! \brief
 237          * Requires the option to be specified explicitly.
 238          *
 239          * Note that if you specify defaultValue() together with required(),
 240          * the user is not required to explicitly provide the option.
 241          * In this case, required() only affects possible help output.
 242          */
 243         MyClass &required(bool bRequired = true)
 244         { setFlag(efOption_Required, bRequired); return me(); }
 245         //! Allows the option to be specified multiple times.
 246         MyClass &allowMultiple(bool bMulti = true)
 247         { setFlag(efOption_MultipleTimes, bMulti); return me(); }
 248         //! Requires exactly \p count values for the option.
 249         MyClass &valueCount(int count) { setValueCount(count); return me(); }
 250         //! Allows any number of values for the option.
 251         MyClass &multiValue() { maxValueCount_ = -1; return me(); }
 252
 253         /*! \brief
 254          * Sets a default value for the option.
 255          *
 256          * \param[in] defaultValue Default value.
 257          *
 258          * If the option is never set, the default value is copied to the
 259          * assigned storage.  Note that if the option is not set and there
 260          * is no default value, the storage is not altered, which can also be
 261          * used to provide a default value.  The latter method has to be used
 262          * if the option can take multiple values.
 263          *
 264          * \p defaultValue is copied when the option is created.
 265          */
 266         MyClass &defaultValue(const T &defaultValue)
 267         { defaultValue_ = &defaultValue; return me(); }
 268         /*! \brief
 269          * Sets a default value for the option when it is set.
 270          *
 271          * \param[in] defaultValue Default value.
 272          *
 273          * This value is used if the option is set, but no value is provided.
 274          * If the option is never set, the value set with defaultValue() is
 275          * used.  Can only be used for options that accept a single value.
 276          *
 277          * \p defaultValue is copied when the option is created.
 278          */
 279         MyClass &defaultValueIfSet(const T &defaultValue)
 280         { defaultValueIfSet_ = &defaultValue; return me(); }
 281         /*! \brief
 282          * Stores value(s) in memory pointed by \p store.
 283          *
 284          * \param[in] store  Storage for option value(s).
 285          *
 286          * The caller is responsible for allocating enough memory such that
 287          * the any allowed number of values fits into the array pointed by
 288          * \p store.  If there is no maximum allowed number or if the maximum
 289          * is inconveniently large, storeVector() should be used.
 290          *
 291          * For information on when values are available in the storage, see
 292          * storeVector().
 293          *
 294          * The pointer provided should remain valid as long as the associated
 295          * Options object exists.
 296          */
 297         MyClass &store(T *store)
 298         { store_ = store; return me(); }
 299         /*! \brief
 300          * Stores number of values in the value pointed by \p countptr.
 301          *
 302          * \param[in] countptr Storage for the number of values.
 303          *
 304          * For information on when values are available in the storage, see
 305          * storeVector().
 306          *
 307          * The pointers provided should remain valid as long as the associated
 308          * Options object exists.
 309          */
 310         MyClass &storeCount(int *countptr)
 311         { countptr_ = countptr; return me(); }
 312         /*! \brief
 313          * Stores option values in the provided vector.
 314          *
 315          * \param[in] store  Vector to store option values in.
 316          *
 317          * Values are added to the vector after each successful set of values
 318          * is parsed.  Note that for some options, the value may be changed
 319          * later, and is only guaranteed to be correct after Options::finish()
 320          * has been called.
 321          *
 322          * The pointer provided should remain valid as long as the associated
 323          * Options object exists.
 324          */
 325         MyClass &storeVector(std::vector<T> *store)
 326         { storeVector_ = store; return me(); }
 327
 328     protected:
 329         /*! \cond libapi */
 330         //! Alias for the template class for use in base classes.
 331         typedef OptionTemplate<T, U> MyBase;
 332
 333         //! Initializes the name and default values for an option.
 334         explicit OptionTemplate(const char *name)
 335             : AbstractOption(name),
 336               defaultValue_(NULL), defaultValueIfSet_(NULL), store_(NULL),
 337               countptr_(NULL), storeVector_(NULL)
 338         { }
 339
 340         /*! \brief
 341          * Returns a pointer to user-specified default value, or NULL if there
 342          * is none.
 343          */
 344         const T *defaultValue() const { return defaultValue_; }
 345         /*! \brief
 346          * Returns a pointer to user-specified default value, or NULL if there
 347          * is none.
 348          */
 349         const T *defaultValueIfSet() const { return defaultValueIfSet_; }
 350         //! Returns \p *this casted into MyClass to reduce typing.
 351         MyClass &me() { return static_cast<MyClass &>(*this); }
 352         //! \endcond
 353
 354     private:
 355         const T                *defaultValue_;
 356         const T                *defaultValueIfSet_;
 357         T                      *store_;
 358         int                    *countptr_;
 359         std::vector<T>         *storeVector_;
 360
 361         /*! \brief
 362          * Needed to initialize storage from this class without otherwise
 363          * unnecessary accessors.
 364          */
 365         friend class OptionStorageTemplate<T>;
 366 };
 367
 368 /*! \brief
 369  * Gives information and allows modifications to an option after creation.
 370  *
 371  * When an option is added with Options::addOption(), an object of a subclass
 372  * of OptionInfo is returned.  This object can be later used to access
 373  * information about the option.  Non-const methods also allow later changing
 374  * (some of) the option settings provided at initialization time.
 375  * The properties accessible/modifiable through this interface are implemented
 376  * based on need, and may not be implemented for all cases.
 377  *
 378  * \if libapi
 379  * This class is also used by OptionsVisitor and OptionsModifyingVisitor as
 380  * the interface that allows querying/modifying each visited option.
 381  * \endif
 382  *
 383  * This class isolates the details of the internal option implementation from
 384  * callers.  Although this class is a simple reference to the underlying
 385  * implementation, it is implemented as non-copyable to allow const/non-const
 386  * status of a reference to this class to indicate whether modifications are
 387  * allowed.  Otherwise, separate classes would be needed for access and
 388  * modification, complicating the implementation.  In the implementation,
 389  * there is always a single OptionInfo instance referring to one option.
 390  * The underlying implementation object always owns this instance, and only
 391  * references are passed to callers.
 392  *
 393  * \see Options::addOption()
 394  * \if libapi
 395  * \see OptionsVisitor
 396  * \see OptionsModifyingVisitor
 397  * \endif
 398  *
 399  * \inpublicapi
 400  * \ingroup module_options
 401  */
 402 class OptionInfo
 403 {
 404     public:
 405         virtual ~OptionInfo();
 406
 407         /*! \brief
 408          * Test whether the option is of a particular type.
 409          *
 410          * \tparam InfoType  Option type to test for. Should be a class derived
 411          *      from OptionInfo.
 412          */
 413         template <class InfoType>
 414         bool isType() const
 415         {
 416             return toType<InfoType>() != NULL;
 417         }
 418         /*! \brief
 419          * Convert the info object to a particular type if the type is correct.
 420          *
 421          * \tparam InfoType  Option type to convert to. Should be a class
 422          *      derived from OptionInfo.
 423          * \retval this converted to a pointer to \p InfoType, or NULL if the
 424          *      conversion is not possible.
 425          */
 426         template <class InfoType>
 427         InfoType *toType()
 428         {
 429             return dynamic_cast<InfoType *>(this);
 430         }
 431         //! \copydoc toType()
 432         template <class InfoType>
 433         const InfoType *toType() const
 434         {
 435             return dynamic_cast<const InfoType *>(this);
 436         }
 437
 438         //! Returns true if the option has been set.
 439         bool isSet() const;
 440         //! Returns true if the option is a hidden option.
 441         bool isHidden() const;
 442         //! Returns true if the option is required.
 443         bool isRequired() const;
 444         //! Returns the name of the option.
 445         const std::string &name() const;
 446         //! Returns the description of the option.
 447         const std::string &description() const;
 448         //! Returns the type of the option as a string.
 449         const char *type() const;
 450         //! Returns the number of values given for the option.
 451         int valueCount() const;
 452         //! Returns the i'th value of the option as a string.
 453         std::string formatValue(int i) const;
 454         /*! \brief
 455          * Returns the default value if set for the option as a string.
 456          *
 457          * \see OptionTemplate::defaultValueIfSet()
 458          */
 459         std::string formatDefaultValueIfSet() const;
 460
 461     protected:
 462         /*! \cond libapi */
 463         /*! \brief
 464          * Wraps a given option object.
 465          *
 466          * Does not throw.
 467          */
 468         explicit OptionInfo(AbstractOptionStorage *option);
 469
 470         //! Returns the wrapped option storage object.
 471         AbstractOptionStorage       &option() { return option_; }
 472         //! Returns the wrapped option storage object.
 473         const AbstractOptionStorage &option() const { return option_; }
 474         //! \endcond
 475
 476     private:
 477         //! The wrapped option.
 478         AbstractOptionStorage  &option_;
 479
 480         GMX_DISALLOW_COPY_AND_ASSIGN(OptionInfo);
 481 };
 482
 483 } // namespace gmx
 484
 485 #endif