src/gromacs/options/abstractoptionstorage.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \libinternal \file
  32  * \brief
  33  * Declares gmx::AbstractOptionStorage.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inlibraryapi
  37  * \ingroup module_options
  38  */
  39 #ifndef GMX_OPTIONS_ABSTRACTOPTIONSTORAGE_H
  40 #define GMX_OPTIONS_ABSTRACTOPTIONSTORAGE_H
  41
  42 #include <string>
  43
  44 #include "../utility/common.h"
  45
  46 #include "optionflags.h"
  47
  48 namespace gmx
  49 {
  50
  51 class AbstractOption;
  52 class OptionInfo;
  53 class Options;
  54
  55 /*! \libinternal \brief
  56  * Abstract base class for converting, validating, and storing option values.
  57  *
  58  * This class should normally not be subclassed directly, but the
  59  * OptionStorageTemplate should be used instead.  The templated class provides
  60  * basic functionality for most of the pure virtual methods, and also
  61  * integrates well with option setting objects derived from OptionTemplate.
  62  *
  63  * \inlibraryapi
  64  * \ingroup module_options
  65  *
  66  * \internal
  67  * This class really consists of two parts: the public interface that is
  68  * used by the internal implementation of the options module, and the
  69  * interface that derived classes use to provide type-dependent functionality.
  70  * The latter consists of a few pure virtual methods, of which a few simple
  71  * query methods are also part of the module-internal interface, others are
  72  * protected and called by the non-virtual methods when needed.
  73  * The reason why these two roles are in one class is twofold:
  74  *  -# Both the derived classes and the internal module implementation may need
  75  *     access to the same information like the allowed number of values and the
  76  *     name of the option.
  77  *  -# Having only one class is consistent with the structure used for options
  78  *     settings objects: there is very direct correspondence between
  79  *     AbstractOption and AbstractOptionStorage and between OptionTemplate and
  80  *     OptionStorageTemplate.
  81  */
  82 class AbstractOptionStorage
  83 {
  84     public:
  85         virtual ~AbstractOptionStorage();
  86
  87         //! Returns true if the option has been set.
  88         bool isSet() const { return hasFlag(efSet); }
  89         /*! \brief
  90          * Returns true if the option is a boolean option.
  91          *
  92          * This is used to optionally support an alternative syntax where an
  93          * option provided with no value sets the value to true and an
  94          * option prefixed with "no" clears the value.
  95          */
  96         bool isBoolean() const;
  97         //! Returns true if the option is a hidden option.
  98         bool isHidden() const { return hasFlag(efHidden); }
  99         //! Returns true if the option is required.
 100         bool isRequired() const { return hasFlag(efRequired); }
 101         //! Returns the name of the option.
 102         const std::string &name() const { return _name; }
 103         //! Returns the description of the option.
 104         const std::string &description() const { return _descr; }
 105
 106         /*! \brief
 107          * Returns an option info object corresponding to this option.
 108          */
 109         virtual OptionInfo &optionInfo() = 0;
 110         /*! \brief
 111          * Returns a short string describing the type of the option.
 112          *
 113          * The caller is free to discard the returned string.
 114          */
 115         virtual const char *typeString() const = 0;
 116         /*! \brief
 117          * Returns the number of option values added so far.
 118          */
 119         virtual int valueCount() const = 0;
 120         /*! \brief
 121          * Returns the i'th value formatted as a string.
 122          */
 123         virtual std::string formatValue(int i) const = 0;
 124
 125         /*! \brief
 126          * Starts adding values from a new source for the option.
 127          *
 128          * This marks the vurrent value of the option as a default value,
 129          * causing next call to startSet() to clear it.  This allows values
 130          * from the new source to overwrite old values.
 131          *
 132          * This method does not throw.
 133          */
 134         void startSource();
 135         /*! \brief
 136          * Starts adding a new set of values for the option.
 137          *
 138          * \throws  InvalidInputError if option is specified multiple times,
 139          *      but is not specified to accept it.
 140          *
 141          * If the parameter is specified multiple times, startSet() should be
 142          * called before the values for each instance.
 143          *
 144          * Strong exception safety guarantee.
 145          */
 146         void startSet();
 147         /*! \brief
 148          * Adds a new value for the option, converting it from a string.
 149          *
 150          * \param[in] value  String value to convert.
 151          * \throws  InvalidInputError if value cannot be converted, or
 152          *      if there are too many values.
 153          *
 154          * This method should only be called between startSet() and
 155          * finishSet().
 156          */
 157         void appendValue(const std::string &value);
 158         /*! \brief
 159          * Performs validation and/or actions once a set of values has been
 160          * added.
 161          *
 162          * \throws  InvalidInputError if too few values have been provided, or
 163          *      if the valid values since previous startSet() are invalid as a
 164          *      set.
 165          *
 166          * If the parameter is specified multiple times, finishSet() should be
 167          * called after the values for each instance.
 168          */
 169         void finishSet();
 170         /*! \brief
 171          * Performs validation and/or actions once all values have been added.
 172          *
 173          * \throws InvalidInputError if the option is required but not set, or
 174          *      if all valid values together are invalid as a set.
 175          *
 176          * This method should be called after all values have been provided
 177          * with appendValue().
 178          */
 179         void finish();
 180
 181     protected:
 182         /*! \brief
 183          * Initializes the storage object from the settings object.
 184          *
 185          * \param[in] settings  Option settings.
 186          * \param[in] staticFlags Option flags that are always set and specify
 187          *      generic behavior of the option.
 188          * \throws  APIError if invalid settings have been provided.
 189          */
 190         AbstractOptionStorage(const AbstractOption &settings,
 191                               OptionFlags staticFlags);
 192
 193         //! Returns true if the given flag is set.
 194         bool hasFlag(OptionFlag flag) const { return _flags.test(flag); }
 195         //! Sets the given flag.
 196         void setFlag(OptionFlag flag) { return _flags.set(flag); }
 197         //! Clears the given flag.
 198         void clearFlag(OptionFlag flag) { return _flags.clear(flag); }
 199
 200         //! Returns the minimum number of values required in one set.
 201         int minValueCount() const { return _minValueCount; }
 202         //! Returns the maximum allowed number of values in one set (-1 = no limit).
 203         int maxValueCount() const { return _maxValueCount; }
 204         /*! \brief
 205          * Sets a new minimum number of values required in one set.
 206          *
 207          * \param[in] count  New minimum number of values (must be > 0).
 208          * \throws InvalidInputError if already provided values violate the limit.
 209          *
 210          * If values have already been provided, it is checked that there are
 211          * enough.
 212          *
 213          * Cannot be called for options with ::efMulti set, because it is
 214          * impossible to check the requirement after the values have been set.
 215          * If attempted, will assert.
 216          */
 217         void setMinValueCount(int count);
 218         /*! \brief
 219          * Sets a new maximum number of values required in one set.
 220          *
 221          * \param[in] count  New maximum number of values
 222          *                   (must be > 0, or -1 for no limit).
 223          * \throws InvalidInputError if already provided values violate the limit.
 224          *
 225          * If values have already been provided, it is checked that there are
 226          * not too many.
 227          *
 228          * Cannot be called for options with ::efMulti set, because it is
 229          * impossible to check the requirement after the values have been set.
 230          * If attempted, will assert.
 231          */
 232         void setMaxValueCount(int count);
 233
 234         /*! \brief
 235          * Removes all values from temporary storage for a set.
 236          *
 237          * This function is always called before starting to add values to
 238          * a set, allowing the storage to clear its internal buffers.
 239          *
 240          * Should not throw.
 241          */
 242         virtual void clearSet() = 0;
 243         /*! \brief
 244          * Adds a new value, converting it from a string.
 245          *
 246          * \param[in] value  String value to convert.
 247          * \throws  InvalidInputError if \p value is not valid for this option
 248          *      or if there have been too many values in the set.
 249          *
 250          * This method may be called multiple times if the underlying
 251          * option is defined to accept multiple values.
 252          *
 253          * \see OptionStorageTemplate::convertValue()
 254          */
 255         virtual void convertValue(const std::string &value) = 0;
 256         /*! \brief
 257          * Performs validation and/or actions once a set of values has been
 258          * added.
 259          *
 260          * \throws  InvalidInputError if the values in the set are not valid
 261          *      as a whole.
 262          *
 263          * This method may be called multiple times if the underlying option
 264          * can be specified multiple times.
 265          *
 266          * \see OptionStorageTemplate::processSetValues()
 267          */
 268         virtual void processSet() = 0;
 269         /*! \brief
 270          * Performs validation and/or actions once all values have been added.
 271          *
 272          * \throws  InvalidInputError if all provided values are not valid as
 273          *      a set.
 274          *
 275          * This method is always called once.
 276          *
 277          * If the method throws, implementation should take care to leave the
 278          * option in a consistent, meaningful state.  However, currently none
 279          * of the implementations actually throw in any situation where the
 280          * option may be left in an inconsistent state.
 281          */
 282         virtual void processAll() = 0;
 283
 284     private:
 285         std::string             _name;
 286         std::string             _descr;
 287         //! Flags for the option.
 288         OptionFlags             _flags;
 289         //! Minimum number of values required (in one set).
 290         int                     _minValueCount;
 291         //! Maximum allowed number of values (in one set), or -1 if no limit.
 292         int                     _maxValueCount;
 293         //! Whether we are currently assigning values to a set.
 294         bool                    _inSet;
 295
 296         GMX_DISALLOW_COPY_AND_ASSIGN(AbstractOptionStorage);
 297 };
 298
 299 } // namespace gmx
 300
 301 #endif