/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \internal \file
* \brief
* Implements classes in abstractoption.h and abstractoptionstorage.h.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \ingroup module_options
*/
-#include "gromacs/options/abstractoption.h"
+#include "gmxpre.h"
+
+#include "abstractoption.h"
#include "gromacs/options/abstractoptionstorage.h"
#include "gromacs/options/optionflags.h"
-#include "gromacs/options/optioninfo.h"
#include "gromacs/utility/exceptions.h"
#include "gromacs/utility/gmxassert.h"
*/
AbstractOptionStorage::AbstractOptionStorage(const AbstractOption &settings,
- OptionFlags staticFlags)
+ OptionFlags staticFlags)
: flags_(settings.flags_ | staticFlags),
minValueCount_(settings.minValueCount_),
maxValueCount_(settings.maxValueCount_),
- inSet_(false)
+ bInSet_(false), bSetValuesHadErrors_(false)
{
- // If the maximum number of values is not known, storage to
- // caller-allocated memory is unsafe.
- if ((maxValueCount_ < 0 || hasFlag(efMulti)) && hasFlag(efExternalStore))
- {
- GMX_THROW(APIError("Cannot set user-allocated storage for arbitrary number of values"));
- }
// Check that user has not provided incorrect values for vectors.
- if (hasFlag(efVector) && (minValueCount_ > 1 || maxValueCount_ < 1))
+ if (hasFlag(efOption_Vector) && (minValueCount_ > 1 || maxValueCount_ < 1))
{
GMX_THROW(APIError("Inconsistent value counts for vector values"));
}
{
name_ = settings.name_;
}
- descr_ = settings.createDescription();
+ if (settings.descr_ != NULL)
+ {
+ descr_ = settings.descr_;
+ }
+ setFlag(efOption_ClearOnNextSet);
}
AbstractOptionStorage::~AbstractOptionStorage()
void AbstractOptionStorage::startSource()
{
- setFlag(efClearOnNextSet);
+ setFlag(efOption_ClearOnNextSet);
}
void AbstractOptionStorage::startSet()
{
- GMX_RELEASE_ASSERT(!inSet_, "finishSet() not called");
+ GMX_RELEASE_ASSERT(!bInSet_, "finishSet() not called");
// The last condition takes care of the situation where multiple
// sources are used, and a later source should be able to reassign
// the value even though the option is already set.
- if (isSet() && !hasFlag(efMulti) && !hasFlag(efClearOnNextSet))
+ if (isSet() && !hasFlag(efOption_MultipleTimes)
+ && !hasFlag(efOption_ClearOnNextSet))
{
GMX_THROW(InvalidInputError("Option specified multiple times"));
}
clearSet();
- inSet_ = true;
+ bInSet_ = true;
+ bSetValuesHadErrors_ = false;
}
void AbstractOptionStorage::appendValue(const std::string &value)
{
- GMX_RELEASE_ASSERT(inSet_, "startSet() not called");
- convertValue(value);
+ GMX_RELEASE_ASSERT(bInSet_, "startSet() not called");
+ try
+ {
+ convertValue(value);
+ }
+ catch (...)
+ {
+ bSetValuesHadErrors_ = true;
+ throw;
+ }
}
void AbstractOptionStorage::finishSet()
{
- GMX_RELEASE_ASSERT(inSet_, "startSet() not called");
- inSet_ = false;
- // TODO: Should this be done only when processSet() does not throw?
- setFlag(efSet);
- processSet();
+ GMX_RELEASE_ASSERT(bInSet_, "startSet() not called");
+ bInSet_ = false;
+ // We mark the option as set even when there are errors to avoid additional
+ // errors from required options not set.
+ // TODO: There could be a separate flag for this purpose.
+ setFlag(efOption_Set);
+ if (!bSetValuesHadErrors_)
+ {
+ // TODO: Correct handling of the efOption_ClearOnNextSet requires
+ // processSet() and/or convertValue() to check it internally.
+ // OptionStorageTemplate takes care of it, but it's error-prone if
+ // a custom option is implemented that doesn't use it.
+ processSet();
+ }
+ bSetValuesHadErrors_ = false;
+ clearFlag(efOption_ClearOnNextSet);
+ clearSet();
}
void AbstractOptionStorage::finish()
{
- GMX_RELEASE_ASSERT(!inSet_, "finishSet() not called");
+ GMX_RELEASE_ASSERT(!bInSet_, "finishSet() not called");
processAll();
- if (hasFlag(efRequired) && !isSet())
+ if (isRequired() && !(isSet() || hasFlag(efOption_ExplicitDefaultValue)))
{
GMX_THROW(InvalidInputError("Option is required, but not set"));
}
void AbstractOptionStorage::setMinValueCount(int count)
{
- GMX_RELEASE_ASSERT(!hasFlag(efMulti),
- "setMinValueCount() not supported with efMulti");
+ GMX_RELEASE_ASSERT(!hasFlag(efOption_MultipleTimes),
+ "setMinValueCount() not supported with efOption_MultipleTimes");
GMX_RELEASE_ASSERT(count >= 0, "Invalid value count");
minValueCount_ = count;
- if (isSet()
- && !hasFlag(efDontCheckMinimumCount) && valueCount() < minValueCount_)
+ if (isSet() && !hasFlag(efOption_DontCheckMinimumCount)
+ && valueCount() < minValueCount_)
{
GMX_THROW(InvalidInputError("Too few values"));
}
void AbstractOptionStorage::setMaxValueCount(int count)
{
- GMX_RELEASE_ASSERT(!hasFlag(efMulti),
- "setMaxValueCount() not supported with efMulti");
+ GMX_RELEASE_ASSERT(!hasFlag(efOption_MultipleTimes),
+ "setMaxValueCount() not supported with efOption_MultipleTimes");
GMX_RELEASE_ASSERT(count >= -1, "Invalid value count");
maxValueCount_ = count;
if (isSet() && maxValueCount_ >= 0 && valueCount() > maxValueCount_)
return option().isRequired();
}
+int OptionInfo::minValueCount() const
+{
+ if (option().defaultValueIfSetExists())
+ {
+ return 0;
+ }
+ return option().minValueCount();
+}
+
+int OptionInfo::maxValueCount() const
+{
+ return option().maxValueCount();
+}
+
const std::string &OptionInfo::name() const
{
return option().name();
}
-const std::string &OptionInfo::description() const
+std::string OptionInfo::type() const
{
- return option().description();
+ return option().typeString();
}
-const char *OptionInfo::type() const
+std::string OptionInfo::formatDescription() const
{
- return option().typeString();
+ std::string description(option().description());
+ std::string extraDescription(option().formatExtraDescription());
+ if (!extraDescription.empty())
+ {
+ description.append(extraDescription);
+ }
+ return description;
+}
+
+std::string OptionInfo::formatDefaultValueIfSet() const
+{
+ return option().formatDefaultValueIfSet();
}
int OptionInfo::valueCount() const
return option().formatValue(i);
}
-std::string OptionInfo::formatDefaultValueIfSet() const
-{
- return option().formatDefaultValueIfSet();
-}
-
} // namespace gmx
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff