src/gromacs/selection/selectionoptionmanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2018,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares gmx::SelectionOptionManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_selection
  42  */
  43 #ifndef GMX_SELECTION_SELECTIONOPTIONMANAGER_H
  44 #define GMX_SELECTION_SELECTIONOPTIONMANAGER_H
  45
  46 #include <string>
  47
  48 #include "gromacs/options/options.h"
  49 #include "gromacs/utility/classhelpers.h"
  50
  51 namespace gmx
  52 {
  53
  54 class SelectionCollection;
  55 class SelectionOptionStorage;
  56
  57 /*! \brief
  58  * Handles interaction of selection options with other options and user input.
  59  *
  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.
  65  * It needs to be added using Options::addManager() before SelectionOption or
  66  * SelectionFileOption options can be added to an Options collection.
  67  *
  68  * The main features of this class are:
  69  *  - convertOptionValue(), which is used to convert string values into
  70  *    selections for options.
  71  *  - requestOptionDelayedParsing(), which is called by the internal
  72  *    implementation of selection options when an option is provided on the
  73  *    command line without a value.  Such calls are remembered, and the value
  74  *    for all requested options can be later provided by calling one of
  75  *    parseRequestedFromStdin(), parseRequestedFromFile() or
  76  *    parseRequstedFromString().
  77  *
  78  * \inpublicapi
  79  * \ingroup module_selection
  80  */
  81 class SelectionOptionManager : public IOptionManager
  82 {
  83 public:
  84     /*! \brief
  85      * Creates a manager for selection options.
  86      *
  87      * \throws  std::bad_alloc if out of memory.
  88      */
  89     explicit SelectionOptionManager(SelectionCollection* selections);
  90     ~SelectionOptionManager() override;
  91
  92     /*! \brief
  93      * Adds a selection option to be managed.
  94      *
  95      * \param     storage  Storage object for the option to register.
  96      * \throws    std::bad_alloc if out of memory.
  97      *
  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.
 101      *
 102      * Strong exception safety.
 103      */
 104     void registerOption(SelectionOptionStorage* storage);
 105     /*! \brief
 106      * Converts a string value to selections for an option.
 107      *
 108      * \param     storage  Storage object to receive the selections.
 109      * \param[in] value    Value to convert.
 110      * \param[in] bFullValue  If true, the provided selections are the full
 111      *      value of the option, and additional checks are performed.
 112      * \throws    std::bad_alloc if out of memory.
 113      * \throws    InvalidInputError if the selection string is not valid,
 114      *      or uses a feature not supported by the option.
 115      *
 116      * This is only for internal use by the selection module.
 117      * It is not possible to obtain a SelectionOptionStorage pointer
 118      * through any public or library API.
 119      */
 120     void convertOptionValue(SelectionOptionStorage* storage, const std::string& value, bool bFullValue);
 121     /*! \brief
 122      * Adds a selection option for delayed user input.
 123      *
 124      * \param     storage  Storage object for the option to request.
 125      * \throws    std::bad_alloc if out of memory.
 126      *
 127      * This is only for internal use by the selection module.
 128      * It is not possible to obtain a SelectionOptionStorage pointer
 129      * through any public or library API.
 130      *
 131      * Strong exception safety.
 132      */
 133     void requestOptionDelayedParsing(SelectionOptionStorage* storage);
 134
 135     /*! \brief
 136      * Returns whether there are requested selections that need input from
 137      * parseRequestedFrom*().
 138      */
 139     bool hasRequestedSelections() const;
 140
 141     /*! \brief
 142      * Initializes options for setting global selection properties.
 143      *
 144      * \param[in,out] options Options object to initialize.
 145      * \throws        std::bad_alloc if out of memory.
 146      *
 147      * \see SelectionCollection::initOptions()
 148      */
 149     void initOptions(IOptionsContainer* options);
 150
 151     /*! \brief
 152      * Parses selection(s) from standard input for options not yet
 153      * provided.
 154      *
 155      * \param[in]  bInteractive Whether the parser should behave
 156      *      interactively.
 157      * \throws     unspecified  Can throw any exception thrown by
 158      *      SelectionCollection::parseFromStdin().
 159      * \throws     std::bad_alloc if out of memory.
 160      *
 161      * This method cooperates with SelectionOption to allow interactive
 162      * input of requested selections after all options have been processed.
 163      * It should be called after the Options::finish() method has been
 164      * called on all options that add selections to this collection.
 165      * For each required selection option that has not been given, as well
 166      * as for optional selection options that have been specified without
 167      * values, it will prompt the user to input the necessary selections.
 168      */
 169     void parseRequestedFromStdin(bool bInteractive);
 170     /*! \brief
 171      * Parses selection(s) from a file for options not yet provided.
 172      *
 173      * \param[in]  filename Name of the file to parse selections from.
 174      * \throws     unspecified  Can throw any exception thrown by
 175      *      SelectionCollection::parseFromFile().
 176      * \throws     std::bad_alloc if out of memory.
 177      * \throws     InvalidInputError if
 178      *      - the number of selections in \p filename doesn't match the
 179      *        number requested.
 180      *      - any selection uses a feature that is not allowed for the
 181      *        corresponding option.
 182      *      - if there is a request for any number of selections that is
 183      *        not the last (in which case it is not possible to determine
 184      *        which selections belong to which request).
 185      *
 186      * This method behaves as parseRequestedFromStdin(), with two
 187      * exceptions:
 188      *  -# It reads the selections from a file instead of standard input.
 189      *  -# If no requests are pending, assigns values to all required
 190      *     options that have not yet been set.
 191      *
 192      * This method used to implement SelectionFileOption.
 193      *
 194      * \see parseRequestedFromStdin()
 195      */
 196     void parseRequestedFromFile(const std::string& filename);
 197     /*! \brief
 198      * Parses selection(s) from a string for options not yet provided.
 199      *
 200      * \param[in]  str     String to parse.
 201      * \throws     unspecified  Can throw any exception thrown by
 202      *      SelectionCollection::parseFromString().
 203      * \throws     std::bad_alloc if out of memory.
 204      * \throws     InvalidInputError in same conditions as
 205      *      parseRequestedFromFile().
 206      *
 207      * This method behaves as parseRequestedFromFile(), but reads the
 208      * selections from a string instead of a file.
 209      * This method is mainly used for testing.
 210      *
 211      * \see parseRequestedFromFile()
 212      */
 213     void parseRequestedFromString(const std::string& str);
 214
 215 private:
 216     class Impl;
 217
 218     PrivateImplPointer<Impl> impl_;
 219
 220     /*! \brief
 221      * Needed for handling delayed selection parsing requests.
 222      */
 223     friend class SelectionOptionStorage;
 224 };
 225
 226 } // namespace gmx
 227
 228 #endif