2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013, 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.
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 abstractoption.h and abstractoptionstorage.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
42 #include "gromacs/options/abstractoption.h"
44 #include "gromacs/options/abstractoptionstorage.h"
45 #include "gromacs/options/optionflags.h"
46 #include "gromacs/utility/exceptions.h"
47 #include "gromacs/utility/gmxassert.h"
49 #include "basicoptionstorage.h"
54 /********************************************************************
55 * AbstractOptionStorage
58 AbstractOptionStorage::AbstractOptionStorage(const AbstractOption &settings,
59 OptionFlags staticFlags)
60 : flags_(settings.flags_ | staticFlags),
61 minValueCount_(settings.minValueCount_),
62 maxValueCount_(settings.maxValueCount_),
63 bInSet_(false), bSetValuesHadErrors_(false)
65 // Check that user has not provided incorrect values for vectors.
66 if (hasFlag(efOption_Vector) && (minValueCount_ > 1 || maxValueCount_ < 1))
68 GMX_THROW(APIError("Inconsistent value counts for vector values"));
71 if (settings.name_ != NULL)
73 name_ = settings.name_;
75 if (settings.descr_ != NULL)
77 descr_ = settings.descr_;
79 setFlag(efOption_ClearOnNextSet);
82 AbstractOptionStorage::~AbstractOptionStorage()
86 bool AbstractOptionStorage::isBoolean() const
88 return dynamic_cast<const BooleanOptionStorage *>(this) != NULL;
91 void AbstractOptionStorage::startSource()
93 setFlag(efOption_ClearOnNextSet);
96 void AbstractOptionStorage::startSet()
98 GMX_RELEASE_ASSERT(!bInSet_, "finishSet() not called");
99 // The last condition takes care of the situation where multiple
100 // sources are used, and a later source should be able to reassign
101 // the value even though the option is already set.
102 if (isSet() && !hasFlag(efOption_MultipleTimes)
103 && !hasFlag(efOption_ClearOnNextSet))
105 GMX_THROW(InvalidInputError("Option specified multiple times"));
109 bSetValuesHadErrors_ = false;
112 void AbstractOptionStorage::appendValue(const std::string &value)
114 GMX_RELEASE_ASSERT(bInSet_, "startSet() not called");
121 bSetValuesHadErrors_ = true;
126 void AbstractOptionStorage::finishSet()
128 GMX_RELEASE_ASSERT(bInSet_, "startSet() not called");
130 // We mark the option as set even when there are errors to avoid additional
131 // errors from required options not set.
132 // TODO: There could be a separate flag for this purpose.
133 setFlag(efOption_Set);
134 if (!bSetValuesHadErrors_)
136 // TODO: Correct handling of the efOption_ClearOnNextSet requires
137 // processSet() and/or convertValue() to check it internally.
138 // OptionStorageTemplate takes care of it, but it's error-prone if
139 // a custom option is implemented that doesn't use it.
142 bSetValuesHadErrors_ = false;
143 clearFlag(efOption_ClearOnNextSet);
147 void AbstractOptionStorage::finish()
149 GMX_RELEASE_ASSERT(!bInSet_, "finishSet() not called");
151 if (isRequired() && !(isSet() || hasFlag(efOption_ExplicitDefaultValue)))
153 GMX_THROW(InvalidInputError("Option is required, but not set"));
157 void AbstractOptionStorage::setMinValueCount(int count)
159 GMX_RELEASE_ASSERT(!hasFlag(efOption_MultipleTimes),
160 "setMinValueCount() not supported with efOption_MultipleTimes");
161 GMX_RELEASE_ASSERT(count >= 0, "Invalid value count");
162 minValueCount_ = count;
163 if (isSet() && !hasFlag(efOption_DontCheckMinimumCount)
164 && valueCount() < minValueCount_)
166 GMX_THROW(InvalidInputError("Too few values"));
170 void AbstractOptionStorage::setMaxValueCount(int count)
172 GMX_RELEASE_ASSERT(!hasFlag(efOption_MultipleTimes),
173 "setMaxValueCount() not supported with efOption_MultipleTimes");
174 GMX_RELEASE_ASSERT(count >= -1, "Invalid value count");
175 maxValueCount_ = count;
176 if (isSet() && maxValueCount_ >= 0 && valueCount() > maxValueCount_)
178 GMX_THROW(InvalidInputError("Too many values"));
182 /********************************************************************
187 OptionInfo::OptionInfo(AbstractOptionStorage *option)
193 OptionInfo::~OptionInfo()
197 bool OptionInfo::isSet() const
199 return option().isSet();
202 bool OptionInfo::isHidden() const
204 return option().isHidden();
207 bool OptionInfo::isRequired() const
209 return option().isRequired();
212 const std::string &OptionInfo::name() const
214 return option().name();
217 const std::string &OptionInfo::description() const
219 return option().description();
222 const char *OptionInfo::type() const
224 return option().typeString();
227 int OptionInfo::valueCount() const
229 return option().valueCount();
232 std::string OptionInfo::formatValue(int i) const
234 return option().formatValue(i);
237 std::string OptionInfo::formatDefaultValueIfSet() const
239 return option().formatDefaultValueIfSet();