/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 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.
*/
/*! \file
* \brief
* Declares gmx::SelectionOptionManager.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \inpublicapi
* \ingroup module_selection
*/
#include <string>
-#include "../utility/common.h"
+#include "gromacs/options/options.h"
+#include "gromacs/utility/common.h"
namespace gmx
{
+class Options;
class SelectionCollection;
class SelectionOptionStorage;
/*! \brief
* Handles interaction of selection options with other options and user input.
*
- * This class implements features of SelectionOption that require actions
- * outside options parsing. It is also used to pass the selection collection
- * to the selection options, and to implement the coupling between
- * SelectionOption and SelectionFileOption.
- *
- * The main feature of this class (in addition to passing the
- * selectionCollection() method) is that the internal implementation of
- * selection options calls requestDelayedParsing() when an option is provided
- * on the command line without a value. Such calls are remembered, and
- * the value for all requested options can be later provided by calling one of
- * parseRequestedFromStdin(), parseRequestedFromFile() or
- * parseRequstedFromString().
+ * This class implements interaction of SelectionOption with
+ * SelectionCollection, and also implements features of SelectionOption that
+ * require actions outside options parsing.
+ * It also implements the coupling between SelectionOption and
+ * SelectionFileOption.
+ * It needs to be added using Options::addManager() before SelectionOption or
+ * SelectionFileOption options can be added to an Options collection.
*
- * \see setManagerForSelectionOptions()
+ * The main features of this class are:
+ * - convertOptionValue(), which is used to convert string values into
+ * selections for options.
+ * - requestOptionDelayedParsing(), which is called by the internal
+ * implementation of selection options when an option is provided on the
+ * command line without a value. Such calls are remembered, and the value
+ * for all requested options can be later provided by calling one of
+ * parseRequestedFromStdin(), parseRequestedFromFile() or
+ * parseRequstedFromString().
*
* \inpublicapi
* \ingroup module_selection
*/
-class SelectionOptionManager
+class SelectionOptionManager : public OptionManagerInterface
{
public:
/*! \brief
* \throws std::bad_alloc if out of memory.
*/
explicit SelectionOptionManager(SelectionCollection *selections);
- ~SelectionOptionManager();
+ virtual ~SelectionOptionManager();
/*! \brief
- * Returns the selection collection for this manager.
+ * Adds a selection option to be managed.
+ *
+ * \param storage Storage object for the option to register.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * This is only for internal use by the selection module.
+ * It is not possible to obtain a SelectionOptionStorage pointer
+ * through any public or library API.
*
- * Does not throw.
+ * Strong exception safety.
+ */
+ void registerOption(SelectionOptionStorage *storage);
+ /*! \brief
+ * Converts a string value to selections for an option.
+ *
+ * \param storage Storage object to receive the selections.
+ * \param[in] value Value to convert.
+ * \param[in] bFullValue If true, the provided selections are the full
+ * value of the option, and additional checks are performed.
+ * \throws std::bad_alloc if out of memory.
+ * \throws InvalidInputError if the selection string is not valid,
+ * or uses a feature not supported by the option.
+ *
+ * This is only for internal use by the selection module.
+ * It is not possible to obtain a SelectionOptionStorage pointer
+ * through any public or library API.
*/
- SelectionCollection &selectionCollection();
+ void convertOptionValue(SelectionOptionStorage *storage,
+ const std::string &value,
+ bool bFullValue);
/*! \brief
* Adds a selection option for delayed user input.
*
*
* Strong exception safety.
*/
- void requestDelayedParsing(SelectionOptionStorage *storage);
+ void requestOptionDelayedParsing(SelectionOptionStorage *storage);
/*! \brief
* Parses selection(s) from standard input for options not yet
* not the last (in which case it is not possible to determine
* which selections belong to which request).
*
- * This method behaves as parseRequestedFromStdin(), but reads the
- * selections from a file instead of standard input.
- * This is used to implement SelectionFileOption.
+ * This method behaves as parseRequestedFromStdin(), with two
+ * exceptions:
+ * -# It reads the selections from a file instead of standard input.
+ * -# If no requests are pending, assigns values to all required
+ * options that have not yet been set.
+ *
+ * This method used to implement SelectionFileOption.
*
* \see parseRequestedFromStdin()
*/
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff