/usr/include/gromacs/selection/selectionoptionmanager.h is in libgromacs-dev 5.1.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | /*
* This file is part of the GROMACS molecular simulation package.
*
* Copyright (c) 2012,2013,2014,2015, 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.
*
* 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.
*
* 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.
*
* 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 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 research papers on the package. Check out http://www.gromacs.org.
*/
/*! \file
* \brief
* Declares gmx::SelectionOptionManager.
*
* \author Teemu Murtola <teemu.murtola@gmail.com>
* \inpublicapi
* \ingroup module_selection
*/
#ifndef GMX_SELECTION_SELECTIONOPTIONMANAGER_H
#define GMX_SELECTION_SELECTIONOPTIONMANAGER_H
#include <string>
#include "gromacs/options/options.h"
#include "gromacs/utility/classhelpers.h"
namespace gmx
{
class Options;
class SelectionCollection;
class SelectionOptionStorage;
/*! \brief
* Handles interaction of selection options with other options and user input.
*
* 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.
*
* 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 : public OptionManagerInterface
{
public:
/*! \brief
* Creates a manager for selection options.
*
* \throws std::bad_alloc if out of memory.
*/
explicit SelectionOptionManager(SelectionCollection *selections);
virtual ~SelectionOptionManager();
/*! \brief
* 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.
*
* 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.
*/
void convertOptionValue(SelectionOptionStorage *storage,
const std::string &value,
bool bFullValue);
/*! \brief
* Adds a selection option for delayed user input.
*
* \param storage Storage object for the option to request.
* \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.
*
* Strong exception safety.
*/
void requestOptionDelayedParsing(SelectionOptionStorage *storage);
/*! \brief
* Initializes options for setting global selection properties.
*
* \param[in,out] options Options object to initialize.
* \throws std::bad_alloc if out of memory.
*
* \see SelectionCollection::initOptions()
*/
void initOptions(Options *options);
/*! \brief
* Parses selection(s) from standard input for options not yet
* provided.
*
* \param[in] bInteractive Whether the parser should behave
* interactively.
* \throws unspecified Can throw any exception thrown by
* SelectionCollection::parseFromStdin().
* \throws std::bad_alloc if out of memory.
*
* This method cooperates with SelectionOption to allow interactive
* input of requested selections after all options have been processed.
* It should be called after the Options::finish() method has been
* called on all options that add selections to this collection.
* For each required selection option that has not been given, as well
* as for optional selection options that have been specified without
* values, it will prompt the user to input the necessary selections.
*/
void parseRequestedFromStdin(bool bInteractive);
/*! \brief
* Parses selection(s) from a file for options not yet provided.
*
* \param[in] filename Name of the file to parse selections from.
* \throws unspecified Can throw any exception thrown by
* SelectionCollection::parseFromFile().
* \throws std::bad_alloc if out of memory.
* \throws InvalidInputError if
* - the number of selections in \p filename doesn't match the
* number requested.
* - any selection uses a feature that is not allowed for the
* corresponding option.
* - if there is a request for any number of selections that is
* not the last (in which case it is not possible to determine
* which selections belong to which request).
*
* 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()
*/
void parseRequestedFromFile(const std::string &filename);
/*! \brief
* Parses selection(s) from a string for options not yet provided.
*
* \param[in] str String to parse.
* \throws unspecified Can throw any exception thrown by
* SelectionCollection::parseFromString().
* \throws std::bad_alloc if out of memory.
* \throws InvalidInputError in same conditions as
* parseRequestedFromFile().
*
* This method behaves as parseRequestedFromFile(), but reads the
* selections from a string instead of a file.
* This method is mainly used for testing.
*
* \see parseRequestedFromFile()
*/
void parseRequestedFromString(const std::string &str);
private:
class Impl;
PrivateImplPointer<Impl> impl_;
/*! \brief
* Needed for handling delayed selection parsing requests.
*/
friend class SelectionOptionStorage;
};
} // namespace gmx
#endif
|