2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012, 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 * Declares gmx::SelectionOptionManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_selection
43 #ifndef GMX_SELECTION_SELECTIONOPTIONMANAGER_H
44 #define GMX_SELECTION_SELECTIONOPTIONMANAGER_H
48 #include "../utility/common.h"
54 class SelectionCollection;
55 class SelectionOptionStorage;
58 * Handles interaction of selection options with other options and user input.
60 * This class implements interaction of SelectionOption with
61 * SelectionCollection, and also implements features of SelectionOption that
62 * require actions outside options parsing.
63 * It also implements the coupling between SelectionOption and
64 * SelectionFileOption.
66 * The main features of this class are:
67 * - convertOptionValue(), which is used to convert string values into
68 * selections for options.
69 * - requestOptionDelayedParsing(), which is called by the internal
70 * implementation of selection options when an option is provided on the
71 * command line without a value. Such calls are remembered, and the value
72 * for all requested options can be later provided by calling one of
73 * parseRequestedFromStdin(), parseRequestedFromFile() or
74 * parseRequstedFromString().
76 * \see setManagerForSelectionOptions()
79 * \ingroup module_selection
81 class SelectionOptionManager
85 * Creates a manager for selection options.
87 * \throws std::bad_alloc if out of memory.
89 explicit SelectionOptionManager(SelectionCollection *selections);
90 ~SelectionOptionManager();
93 * Adds a selection option to be managed.
95 * \param storage Storage object for the option to register.
96 * \throws std::bad_alloc if out of memory.
98 * This is only for internal use by the selection module.
99 * It is not possible to obtain a SelectionOptionStorage pointer
100 * through any public or library API.
102 * Strong exception safety.
104 void registerOption(SelectionOptionStorage *storage);
106 * Converts a string value to selections for an option.
108 * \param storage Storage object to receive the selections.
109 * \param[in] value Value to convert.
110 * \throws std::bad_alloc if out of memory.
111 * \throws InvalidInputError if the selection string is not valid,
112 * or uses a feature not supported by the option.
114 * This is only for internal use by the selection module.
115 * It is not possible to obtain a SelectionOptionStorage pointer
116 * through any public or library API.
118 void convertOptionValue(SelectionOptionStorage *storage,
119 const std::string &value);
121 * Adds a selection option for delayed user input.
123 * \param storage Storage object for the option to request.
124 * \throws std::bad_alloc if out of memory.
126 * This is only for internal use by the selection module.
127 * It is not possible to obtain a SelectionOptionStorage pointer
128 * through any public or library API.
130 * Strong exception safety.
132 void requestOptionDelayedParsing(SelectionOptionStorage *storage);
135 * Parses selection(s) from standard input for options not yet
138 * \param[in] bInteractive Whether the parser should behave
140 * \throws unspecified Can throw any exception thrown by
141 * SelectionCollection::parseFromStdin().
142 * \throws std::bad_alloc if out of memory.
144 * This method cooperates with SelectionOption to allow interactive
145 * input of requested selections after all options have been processed.
146 * It should be called after the Options::finish() method has been
147 * called on all options that add selections to this collection.
148 * For each required selection option that has not been given, as well
149 * as for optional selection options that have been specified without
150 * values, it will prompt the user to input the necessary selections.
152 void parseRequestedFromStdin(bool bInteractive);
154 * Parses selection(s) from a file for options not yet provided.
156 * \param[in] filename Name of the file to parse selections from.
157 * \throws unspecified Can throw any exception thrown by
158 * SelectionCollection::parseFromFile().
159 * \throws std::bad_alloc if out of memory.
160 * \throws InvalidInputError if
161 * - the number of selections in \p filename doesn't match the
163 * - any selection uses a feature that is not allowed for the
164 * corresponding option.
165 * - if there is a request for any number of selections that is
166 * not the last (in which case it is not possible to determine
167 * which selections belong to which request).
169 * This method behaves as parseRequestedFromStdin(), with two
171 * -# It reads the selections from a file instead of standard input.
172 * -# If no requests are pending, assigns values to all required
173 * options that have not yet been set.
175 * This method used to implement SelectionFileOption.
177 * \see parseRequestedFromStdin()
179 void parseRequestedFromFile(const std::string &filename);
181 * Parses selection(s) from a string for options not yet provided.
183 * \param[in] str String to parse.
184 * \throws unspecified Can throw any exception thrown by
185 * SelectionCollection::parseFromString().
186 * \throws std::bad_alloc if out of memory.
187 * \throws InvalidInputError in same conditions as
188 * parseRequestedFromFile().
190 * This method behaves as parseRequestedFromFile(), but reads the
191 * selections from a string instead of a file.
192 * This method is mainly used for testing.
194 * \see parseRequestedFromFile()
196 void parseRequestedFromString(const std::string &str);
201 PrivateImplPointer<Impl> impl_;
204 * Needed for handling delayed selection parsing requests.
206 friend class SelectionOptionStorage;
210 * Set manager for all selection options.
212 * Recursively sets the manager to \p manager for all selection options in
214 * Must be called before value assignment starts for \p options.
220 void setManagerForSelectionOptions(Options *options,
221 SelectionOptionManager *manager);