src/gromacs/options/abstractoptionstorage.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::AbstractOptionStorage.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_ABSTRACTOPTIONSTORAGE_H
  44 #define GMX_OPTIONS_ABSTRACTOPTIONSTORAGE_H
  45
  46 #include <string>
  47
  48 #include "../utility/common.h"
  49
  50 #include "optionflags.h"
  51
  52 namespace gmx
  53 {
  54
  55 class AbstractOption;
  56 class OptionInfo;
  57 class Options;
  58
  59 /*! \libinternal \brief
  60  * Abstract base class for converting, validating, and storing option values.
  61  *
  62  * This class should normally not be subclassed directly, but the
  63  * OptionStorageTemplate should be used instead.  The templated class provides
  64  * basic functionality for most of the pure virtual methods, and also
  65  * integrates well with option setting objects derived from OptionTemplate.
  66  *
  67  * \inlibraryapi
  68  * \ingroup module_options
  69  *
  70  * \internal
  71  * This class really consists of two parts: the public interface that is
  72  * used by the internal implementation of the options module, and the
  73  * interface that derived classes use to provide type-dependent functionality.
  74  * The latter consists of a few pure virtual methods, of which a few simple
  75  * query methods are also part of the module-internal interface, others are
  76  * protected and called by the non-virtual methods when needed.
  77  * The reason why these two roles are in one class is twofold:
  78  *  -# Both the derived classes and the internal module implementation may need
  79  *     access to the same information like the allowed number of values and the
  80  *     name of the option.
  81  *  -# Having only one class is consistent with the structure used for options
  82  *     settings objects: there is very direct correspondence between
  83  *     AbstractOption and AbstractOptionStorage and between OptionTemplate and
  84  *     OptionStorageTemplate.
  85  */
  86 class AbstractOptionStorage
  87 {
  88     public:
  89         virtual ~AbstractOptionStorage();
  90
  91         //! Returns true if the option has been set.
  92         bool isSet() const { return hasFlag(efOption_Set); }
  93         /*! \brief
  94          * Returns true if the option is a boolean option.
  95          *
  96          * This is used to optionally support an alternative syntax where an
  97          * option provided with no value sets the value to true and an
  98          * option prefixed with "no" clears the value.
  99          */
 100         bool isBoolean() const;
 101         //! Returns true if the option is a hidden option.
 102         bool isHidden() const { return hasFlag(efOption_Hidden); }
 103         //! Returns true if the option is required.
 104         bool isRequired() const { return hasFlag(efOption_Required); }
 105         //! Returns true if the option is vector-valued.
 106         bool isVector() const { return hasFlag(efOption_Vector); }
 107         //! Returns the name of the option.
 108         const std::string &name() const { return name_; }
 109         //! Returns the description of the option.
 110         const std::string &description() const { return descr_; }
 111
 112         /*! \brief
 113          * Returns an option info object corresponding to this option.
 114          */
 115         virtual OptionInfo &optionInfo() = 0;
 116         /*! \brief
 117          * Returns a short string describing the type of the option.
 118          *
 119          * The caller is free to discard the returned string.
 120          */
 121         virtual const char *typeString() const = 0;
 122         /*! \brief
 123          * Returns the number of option values added so far.
 124          */
 125         virtual int valueCount() const = 0;
 126         /*! \brief
 127          * Returns the i'th value formatted as a string.
 128          *
 129          * If \p i is DefaultValueIfSetIndex, should format the default value
 130          * if set (see OptionTemplate::defaultValueIfSet()).
 131          */
 132         virtual std::string formatValue(int i) const = 0;
 133         //! \copydoc OptionInfo::formatDefaultValueIfSet()
 134         std::string formatDefaultValueIfSet() const
 135         { return formatValue(DefaultValueIfSetIndex); }
 136
 137         /*! \brief
 138          * Starts adding values from a new source for the option.
 139          *
 140          * This marks the vurrent value of the option as a default value,
 141          * causing next call to startSet() to clear it.  This allows values
 142          * from the new source to overwrite old values.
 143          *
 144          * This method does not throw.
 145          */
 146         void startSource();
 147         /*! \brief
 148          * Starts adding a new set of values for the option.
 149          *
 150          * \throws  InvalidInputError if option is specified multiple times,
 151          *      but is not specified to accept it.
 152          *
 153          * If the parameter is specified multiple times, startSet() should be
 154          * called before the values for each instance.
 155          *
 156          * Strong exception safety guarantee.
 157          */
 158         void startSet();
 159         /*! \brief
 160          * Adds a new value for the option, converting it from a string.
 161          *
 162          * \param[in] value  String value to convert.
 163          * \throws  InvalidInputError if value cannot be converted, or
 164          *      if there are too many values.
 165          *
 166          * This method should only be called between startSet() and
 167          * finishSet().
 168          */
 169         void appendValue(const std::string &value);
 170         /*! \brief
 171          * Performs validation and/or actions once a set of values has been
 172          * added.
 173          *
 174          * \throws  InvalidInputError if too few values have been provided, or
 175          *      if the valid values since previous startSet() are invalid as a
 176          *      set.
 177          *
 178          * If the parameter is specified multiple times, finishSet() should be
 179          * called after the values for each instance.
 180          */
 181         void finishSet();
 182         /*! \brief
 183          * Performs validation and/or actions once all values have been added.
 184          *
 185          * \throws InvalidInputError if the option is required but not set, or
 186          *      if all valid values together are invalid as a set.
 187          *
 188          * This method should be called after all values have been provided
 189          * with appendValue().
 190          */
 191         void finish();
 192
 193     protected:
 194         //! Index used with formatValue() for formatting default value if set.
 195         static const int DefaultValueIfSetIndex = -1;
 196
 197         /*! \brief
 198          * Initializes the storage object from the settings object.
 199          *
 200          * \param[in] settings  Option settings.
 201          * \param[in] staticFlags Option flags that are always set and specify
 202          *      generic behavior of the option.
 203          * \throws  APIError if invalid settings have been provided.
 204          */
 205         AbstractOptionStorage(const AbstractOption &settings,
 206                               OptionFlags           staticFlags);
 207
 208         //! Marks the option as set.
 209         void markAsSet() { flags_.set(efOption_Set); }
 210         //! Returns true if the given flag is set.
 211         bool hasFlag(OptionFlag flag) const { return flags_.test(flag); }
 212         //! Sets the given flag.
 213         void setFlag(OptionFlag flag) { return flags_.set(flag); }
 214         //! Clears the given flag.
 215         void clearFlag(OptionFlag flag) { return flags_.clear(flag); }
 216
 217         //! Returns the minimum number of values required in one set.
 218         int minValueCount() const { return minValueCount_; }
 219         //! Returns the maximum allowed number of values in one set (-1 = no limit).
 220         int maxValueCount() const { return maxValueCount_; }
 221         /*! \brief
 222          * Sets a new minimum number of values required in one set.
 223          *
 224          * \param[in] count  New minimum number of values (must be > 0).
 225          * \throws InvalidInputError if already provided values violate the limit.
 226          *
 227          * If values have already been provided, it is checked that there are
 228          * enough.
 229          *
 230          * Cannot be called for options with ::efOption_MultipleTimes set,
 231          * because it is impossible to check the requirement after the values
 232          * have been set.
 233          * If attempted, will assert.
 234          */
 235         void setMinValueCount(int count);
 236         /*! \brief
 237          * Sets a new maximum number of values required in one set.
 238          *
 239          * \param[in] count  New maximum number of values
 240          *                   (must be > 0, or -1 for no limit).
 241          * \throws InvalidInputError if already provided values violate the limit.
 242          *
 243          * If values have already been provided, it is checked that there are
 244          * not too many.
 245          *
 246          * Cannot be called for options with ::efOption_MultipleTimes set,
 247          * because it is impossible to check the requirement after the values
 248          * have been set.
 249          * If attempted, will assert.
 250          */
 251         void setMaxValueCount(int count);
 252
 253         /*! \brief
 254          * Removes all values from temporary storage for a set.
 255          *
 256          * This function is always called before starting to add values to
 257          * a set, allowing the storage to clear its internal buffers.
 258          *
 259          * Should not throw.
 260          */
 261         virtual void clearSet() = 0;
 262         /*! \brief
 263          * Adds a new value, converting it from a string.
 264          *
 265          * \param[in] value  String value to convert.
 266          * \throws  InvalidInputError if \p value is not valid for this option
 267          *      or if there have been too many values in the set.
 268          *
 269          * This method may be called multiple times if the underlying
 270          * option is defined to accept multiple values.
 271          *
 272          * \see OptionStorageTemplate::convertValue()
 273          */
 274         virtual void convertValue(const std::string &value) = 0;
 275         /*! \brief
 276          * Performs validation and/or actions once a set of values has been
 277          * added.
 278          *
 279          * \throws  InvalidInputError if the values in the set are not valid
 280          *      as a whole.
 281          *
 282          * This method may be called multiple times if the underlying option
 283          * can be specified multiple times.
 284          * This method is not currently called if one of the convertValue()
 285          * calls throwed.
 286          *
 287          * \todo
 288          * Improve the call semantics.
 289          *
 290          * \see OptionStorageTemplate::processSetValues()
 291          */
 292         virtual void processSet() = 0;
 293         /*! \brief
 294          * Performs validation and/or actions once all values have been added.
 295          *
 296          * \throws  InvalidInputError if all provided values are not valid as
 297          *      a set.
 298          *
 299          * This method is always called once.
 300          *
 301          * If the method throws, implementation should take care to leave the
 302          * option in a consistent, meaningful state.  However, currently none
 303          * of the implementations actually throw in any situation where the
 304          * option may be left in an inconsistent state.
 305          */
 306         virtual void processAll() = 0;
 307
 308     private:
 309         std::string             name_;
 310         std::string             descr_;
 311         //! Flags for the option.
 312         OptionFlags             flags_;
 313         //! Minimum number of values required (in one set).
 314         int                     minValueCount_;
 315         //! Maximum allowed number of values (in one set), or -1 if no limit.
 316         int                     maxValueCount_;
 317         //! Whether we are currently assigning values to a set.
 318         bool                    bInSet_;
 319         //! Whether there were errors in set values.
 320         bool                    bSetValuesHadErrors_;
 321
 322         GMX_DISALLOW_COPY_AND_ASSIGN(AbstractOptionStorage);
 323 };
 324
 325 } // namespace gmx
 326
 327 #endif