2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013,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.
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.
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.
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.
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.
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.
37 * Implements classes in basicoptions.h and basicoptionstorage.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
42 #include "basicoptions.h"
43 #include "basicoptionstorage.h"
53 #include "gromacs/utility/cstringutil.h"
54 #include "gromacs/utility/exceptions.h"
55 #include "gromacs/utility/stringutil.h"
61 * Expands a single value to a vector by copying the value.
63 * \tparam ValueType Type of values to process.
64 * \param[in] length Length of the resulting vector.
65 * \param[in,out] values Values to process.
66 * \throws std::bad_alloc if out of memory.
67 * \throws InvalidInputError if \p values has an invalid number of values.
69 * \p values should have 0, 1, or \p length values.
70 * If \p values has 1 value, it is expanded such that it has \p length
71 * identical values. In other valid cases, nothing is done.
73 template <typename ValueType>
74 void expandVector(size_t length, std::vector<ValueType> *values)
76 if (length > 0 && !values->empty() && values->size() != length)
78 if (values->size() != 1)
80 GMX_THROW(gmx::InvalidInputError(gmx::formatString(
81 "Expected 1 or %d values, got %d", length, values->size())));
83 const ValueType &value = (*values)[0];
84 values->resize(length, value);
93 /********************************************************************
94 * BooleanOptionStorage
97 std::string BooleanOptionStorage::formatSingleValue(const bool &value) const
99 return value ? "yes" : "no";
102 void BooleanOptionStorage::convertValue(const std::string &value)
104 // TODO: Case-independence
105 if (value == "1" || value == "yes" || value == "true")
110 else if (value == "0" || value == "no" || value == "false")
115 GMX_THROW(InvalidInputError("Invalid value: '" + value + "'; supported values are: 1, 0, yes, no, true, false"));
118 /********************************************************************
122 BooleanOptionInfo::BooleanOptionInfo(BooleanOptionStorage *option)
127 const BooleanOptionStorage &BooleanOptionInfo::option() const
129 return static_cast<const BooleanOptionStorage &>(OptionInfo::option());
132 bool BooleanOptionInfo::defaultValue() const
134 return option().defaultValue();
137 /********************************************************************
141 AbstractOptionStoragePointer BooleanOption::createStorage() const
143 return AbstractOptionStoragePointer(new BooleanOptionStorage(*this));
147 /********************************************************************
148 * IntegerOptionStorage
151 std::string IntegerOptionStorage::formatSingleValue(const int &value) const
153 return formatString("%d", value);
156 void IntegerOptionStorage::convertValue(const std::string &value)
158 const char *ptr = value.c_str();
161 long int ival = std::strtol(ptr, &endptr, 10);
163 || ival < std::numeric_limits<int>::min()
164 || ival > std::numeric_limits<int>::max())
166 GMX_THROW(InvalidInputError("Invalid value: '" + value
167 + "'; it causes an integer overflow"));
169 if (*ptr == '\0' || *endptr != '\0')
171 GMX_THROW(InvalidInputError("Invalid value: '" + value
172 + "'; expected an integer"));
177 void IntegerOptionStorage::processSetValues(ValueList *values)
181 expandVector(maxValueCount(), values);
185 /********************************************************************
189 IntegerOptionInfo::IntegerOptionInfo(IntegerOptionStorage *option)
194 /********************************************************************
198 AbstractOptionStoragePointer IntegerOption::createStorage() const
200 return AbstractOptionStoragePointer(new IntegerOptionStorage(*this));
204 /********************************************************************
208 std::string Int64OptionStorage::formatSingleValue(const gmx_int64_t &value) const
210 return formatString("%" GMX_PRId64, value);
213 void Int64OptionStorage::convertValue(const std::string &value)
215 const char *ptr = value.c_str();
218 const gmx_int64_t ival = str_to_int64_t(ptr, &endptr);
221 GMX_THROW(InvalidInputError("Invalid value: '" + value
222 + "'; it causes an integer overflow"));
224 if (*ptr == '\0' || *endptr != '\0')
226 GMX_THROW(InvalidInputError("Invalid value: '" + value
227 + "'; expected an integer"));
232 /********************************************************************
236 Int64OptionInfo::Int64OptionInfo(Int64OptionStorage *option)
241 /********************************************************************
245 AbstractOptionStoragePointer Int64Option::createStorage() const
247 return AbstractOptionStoragePointer(new Int64OptionStorage(*this));
251 /********************************************************************
252 * DoubleOptionStorage
255 DoubleOptionStorage::DoubleOptionStorage(const DoubleOption &settings)
256 : MyBase(settings), info_(this), bTime_(settings.bTime_), factor_(1.0)
260 std::string DoubleOptionStorage::typeString() const
262 return isVector() ? "vector" : (isTime() ? "time" : "real");
265 std::string DoubleOptionStorage::formatSingleValue(const double &value) const
267 return formatString("%g", value / factor_);
270 void DoubleOptionStorage::convertValue(const std::string &value)
272 const char *ptr = value.c_str();
275 double dval = std::strtod(ptr, &endptr);
278 GMX_THROW(InvalidInputError("Invalid value: '" + value
279 + "'; it causes an overflow/underflow"));
281 if (*ptr == '\0' || *endptr != '\0')
283 GMX_THROW(InvalidInputError("Invalid value: '" + value
284 + "'; expected a number"));
286 addValue(dval * factor_);
289 void DoubleOptionStorage::processSetValues(ValueList *values)
293 expandVector(maxValueCount(), values);
297 void DoubleOptionStorage::setScaleFactor(double factor)
299 GMX_RELEASE_ASSERT(factor > 0.0, "Invalid scaling factor");
300 if (!hasFlag(efOption_HasDefaultValue))
302 double scale = factor / factor_;
303 ValueList::iterator i;
304 for (i = values().begin(); i != values().end(); ++i)
313 /********************************************************************
317 DoubleOptionInfo::DoubleOptionInfo(DoubleOptionStorage *option)
322 DoubleOptionStorage &DoubleOptionInfo::option()
324 return static_cast<DoubleOptionStorage &>(OptionInfo::option());
327 const DoubleOptionStorage &DoubleOptionInfo::option() const
329 return static_cast<const DoubleOptionStorage &>(OptionInfo::option());
332 bool DoubleOptionInfo::isTime() const
334 return option().isTime();
337 void DoubleOptionInfo::setScaleFactor(double factor)
339 option().setScaleFactor(factor);
342 /********************************************************************
346 AbstractOptionStoragePointer DoubleOption::createStorage() const
348 return AbstractOptionStoragePointer(new DoubleOptionStorage(*this));
352 /********************************************************************
356 FloatOptionStorage::FloatOptionStorage(const FloatOption &settings)
357 : MyBase(settings), info_(this), bTime_(settings.bTime_), factor_(1.0)
361 std::string FloatOptionStorage::typeString() const
363 return isVector() ? "vector" : (isTime() ? "time" : "real");
366 std::string FloatOptionStorage::formatSingleValue(const float &value) const
368 return formatString("%g", value / factor_);
371 void FloatOptionStorage::convertValue(const std::string &value)
373 const char *ptr = value.c_str();
376 double dval = std::strtod(ptr, &endptr);
378 || dval * factor_ < -std::numeric_limits<float>::max()
379 || dval * factor_ > std::numeric_limits<float>::max())
381 GMX_THROW(InvalidInputError("Invalid value: '" + value
382 + "'; it causes an overflow/underflow"));
384 if (*ptr == '\0' || *endptr != '\0')
386 GMX_THROW(InvalidInputError("Invalid value: '" + value
387 + "'; expected a number"));
389 addValue(dval * factor_);
392 void FloatOptionStorage::processSetValues(ValueList *values)
396 expandVector(maxValueCount(), values);
400 void FloatOptionStorage::setScaleFactor(double factor)
402 GMX_RELEASE_ASSERT(factor > 0.0, "Invalid scaling factor");
403 if (!hasFlag(efOption_HasDefaultValue))
405 double scale = factor / factor_;
406 ValueList::iterator i;
407 for (i = values().begin(); i != values().end(); ++i)
416 /********************************************************************
420 FloatOptionInfo::FloatOptionInfo(FloatOptionStorage *option)
425 FloatOptionStorage &FloatOptionInfo::option()
427 return static_cast<FloatOptionStorage &>(OptionInfo::option());
430 const FloatOptionStorage &FloatOptionInfo::option() const
432 return static_cast<const FloatOptionStorage &>(OptionInfo::option());
435 bool FloatOptionInfo::isTime() const
437 return option().isTime();
440 void FloatOptionInfo::setScaleFactor(double factor)
442 option().setScaleFactor(factor);
445 /********************************************************************
449 AbstractOptionStoragePointer FloatOption::createStorage() const
451 return AbstractOptionStoragePointer(new FloatOptionStorage(*this));
455 /********************************************************************
456 * StringOptionStorage
459 StringOptionStorage::StringOptionStorage(const StringOption &settings)
460 : MyBase(settings), info_(this), enumIndexStore_(NULL)
462 if (settings.defaultEnumIndex_ >= 0 && settings.enumValues_ == NULL)
464 GMX_THROW(APIError("Cannot set default enum index without enum values"));
466 if (settings.enumIndexStore_ != NULL && settings.enumValues_ == NULL)
468 GMX_THROW(APIError("Cannot set enum index store without enum values"));
470 if (settings.enumIndexStore_ != NULL && settings.maxValueCount_ < 0)
472 GMX_THROW(APIError("Cannot set enum index store with arbitrary number of values"));
474 if (settings.enumValues_ != NULL)
476 enumIndexStore_ = settings.enumIndexStore_;
477 const std::string *defaultValue = settings.defaultValue();
479 int count = settings.enumValuesCount_;
483 while (settings.enumValues_[count] != NULL)
488 for (int i = 0; i < count; ++i)
490 if (settings.enumValues_[i] == NULL)
492 GMX_THROW(APIError("Enumeration value cannot be NULL"));
494 if (defaultValue != NULL && settings.enumValues_[i] == *defaultValue)
498 allowed_.push_back(settings.enumValues_[i]);
500 if (defaultValue != NULL)
504 GMX_THROW(APIError("Default value is not one of allowed values"));
507 if (settings.defaultEnumIndex_ >= 0)
509 if (settings.defaultEnumIndex_ >= static_cast<int>(allowed_.size()))
511 GMX_THROW(APIError("Default enumeration index is out of range"));
513 if (defaultValue != NULL && *defaultValue != allowed_[settings.defaultEnumIndex_])
515 GMX_THROW(APIError("Conflicting default values"));
518 // If there is no default value, match is still -1.
519 if (enumIndexStore_ != NULL)
521 *enumIndexStore_ = match;
524 if (settings.defaultEnumIndex_ >= 0)
527 addValue(allowed_[settings.defaultEnumIndex_]);
532 std::string StringOptionStorage::formatExtraDescription() const
535 if (!allowed_.empty())
538 ValueList::const_iterator i;
539 for (i = allowed_.begin(); i != allowed_.end(); ++i)
541 if (i != allowed_.begin())
551 std::string StringOptionStorage::formatSingleValue(const std::string &value) const
556 void StringOptionStorage::convertValue(const std::string &value)
558 if (allowed_.size() == 0)
564 ValueList::const_iterator i;
565 ValueList::const_iterator match = allowed_.end();
566 for (i = allowed_.begin(); i != allowed_.end(); ++i)
568 // TODO: Case independence.
569 if (i->find(value) == 0)
571 if (match == allowed_.end() || i->size() < match->size())
577 if (match == allowed_.end())
579 GMX_THROW(InvalidInputError("Invalid value: " + value));
585 void StringOptionStorage::refreshValues()
587 MyBase::refreshValues();
588 if (enumIndexStore_ != NULL)
590 for (size_t i = 0; i < values().size(); ++i)
592 ValueList::const_iterator match =
593 std::find(allowed_.begin(), allowed_.end(), values()[i]);
594 GMX_ASSERT(match != allowed_.end(),
595 "Enum value not found (internal error)");
596 enumIndexStore_[i] = static_cast<int>(match - allowed_.begin());
601 /********************************************************************
605 StringOptionInfo::StringOptionInfo(StringOptionStorage *option)
610 StringOptionStorage &StringOptionInfo::option()
612 return static_cast<StringOptionStorage &>(OptionInfo::option());
615 const StringOptionStorage &StringOptionInfo::option() const
617 return static_cast<const StringOptionStorage &>(OptionInfo::option());
620 bool StringOptionInfo::isEnumerated() const
622 return !allowedValues().empty();
625 const std::vector<std::string> &StringOptionInfo::allowedValues() const
627 return option().allowedValues();
630 /********************************************************************
634 AbstractOptionStoragePointer StringOption::createStorage() const
636 return AbstractOptionStoragePointer(new StringOptionStorage(*this));