src/gromacs/options/abstractoptionstorage.h

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