src/gromacs/selection/selectionoptionmanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, 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/common.h"
  50
  51 namespace gmx
  52 {
  53
  54 class Options;
  55 class SelectionCollection;
  56 class SelectionOptionStorage;
  57
  58 /*! \brief
  59  * Handles interaction of selection options with other options and user input.
  60  *
  61  * This class implements interaction of SelectionOption with
  62  * SelectionCollection, and also implements features of SelectionOption that
  63  * require actions outside options parsing.
  64  * It also implements the coupling between SelectionOption and
  65  * SelectionFileOption.
  66  * It needs to be added using Options::addManager() before SelectionOption or
  67  * SelectionFileOption options can be added to an Options collection.
  68  *
  69  * The main features of this class are:
  70  *  - convertOptionValue(), which is used to convert string values into
  71  *    selections for options.
  72  *  - requestOptionDelayedParsing(), which is called by the internal
  73  *    implementation of selection options when an option is provided on the
  74  *    command line without a value.  Such calls are remembered, and the value
  75  *    for all requested options can be later provided by calling one of
  76  *    parseRequestedFromStdin(), parseRequestedFromFile() or
  77  *    parseRequstedFromString().
  78  *
  79  * \inpublicapi
  80  * \ingroup module_selection
  81  */
  82 class SelectionOptionManager : public OptionManagerInterface
  83 {
  84     public:
  85         /*! \brief
  86          * Creates a manager for selection options.
  87          *
  88          * \throws  std::bad_alloc if out of memory.
  89          */
  90         explicit SelectionOptionManager(SelectionCollection *selections);
  91         virtual ~SelectionOptionManager();
  92
  93         /*! \brief
  94          * Adds a selection option to be managed.
  95          *
  96          * \param     storage  Storage object for the option to register.
  97          * \throws    std::bad_alloc if out of memory.
  98          *
  99          * This is only for internal use by the selection module.
 100          * It is not possible to obtain a SelectionOptionStorage pointer
 101          * through any public or library API.
 102          *
 103          * Strong exception safety.
 104          */
 105         void registerOption(SelectionOptionStorage *storage);
 106         /*! \brief
 107          * Converts a string value to selections for an option.
 108          *
 109          * \param     storage  Storage object to receive the selections.
 110          * \param[in] value    Value to convert.
 111          * \param[in] bFullValue  If true, the provided selections are the full
 112          *      value of the option, and additional checks are performed.
 113          * \throws    std::bad_alloc if out of memory.
 114          * \throws    InvalidInputError if the selection string is not valid,
 115          *      or uses a feature not supported by the option.
 116          *
 117          * This is only for internal use by the selection module.
 118          * It is not possible to obtain a SelectionOptionStorage pointer
 119          * through any public or library API.
 120          */
 121         void convertOptionValue(SelectionOptionStorage *storage,
 122                                 const std::string      &value,
 123                                 bool                    bFullValue);
 124         /*! \brief
 125          * Adds a selection option for delayed user input.
 126          *
 127          * \param     storage  Storage object for the option to request.
 128          * \throws    std::bad_alloc if out of memory.
 129          *
 130          * This is only for internal use by the selection module.
 131          * It is not possible to obtain a SelectionOptionStorage pointer
 132          * through any public or library API.
 133          *
 134          * Strong exception safety.
 135          */
 136         void requestOptionDelayedParsing(SelectionOptionStorage *storage);
 137
 138         /*! \brief
 139          * Parses selection(s) from standard input for options not yet
 140          * provided.
 141          *
 142          * \param[in]  bInteractive Whether the parser should behave
 143          *      interactively.
 144          * \throws     unspecified  Can throw any exception thrown by
 145          *      SelectionCollection::parseFromStdin().
 146          * \throws     std::bad_alloc if out of memory.
 147          *
 148          * This method cooperates with SelectionOption to allow interactive
 149          * input of requested selections after all options have been processed.
 150          * It should be called after the Options::finish() method has been
 151          * called on all options that add selections to this collection.
 152          * For each required selection option that has not been given, as well
 153          * as for optional selection options that have been specified without
 154          * values, it will prompt the user to input the necessary selections.
 155          */
 156         void parseRequestedFromStdin(bool bInteractive);
 157         /*! \brief
 158          * Parses selection(s) from a file for options not yet provided.
 159          *
 160          * \param[in]  filename Name of the file to parse selections from.
 161          * \throws     unspecified  Can throw any exception thrown by
 162          *      SelectionCollection::parseFromFile().
 163          * \throws     std::bad_alloc if out of memory.
 164          * \throws     InvalidInputError if
 165          *      - the number of selections in \p filename doesn't match the
 166          *        number requested.
 167          *      - any selection uses a feature that is not allowed for the
 168          *        corresponding option.
 169          *      - if there is a request for any number of selections that is
 170          *        not the last (in which case it is not possible to determine
 171          *        which selections belong to which request).
 172          *
 173          * This method behaves as parseRequestedFromStdin(), with two
 174          * exceptions:
 175          *  -# It reads the selections from a file instead of standard input.
 176          *  -# If no requests are pending, assigns values to all required
 177          *     options that have not yet been set.
 178          *
 179          * This method used to implement SelectionFileOption.
 180          *
 181          * \see parseRequestedFromStdin()
 182          */
 183         void parseRequestedFromFile(const std::string &filename);
 184         /*! \brief
 185          * Parses selection(s) from a string for options not yet provided.
 186          *
 187          * \param[in]  str     String to parse.
 188          * \throws     unspecified  Can throw any exception thrown by
 189          *      SelectionCollection::parseFromString().
 190          * \throws     std::bad_alloc if out of memory.
 191          * \throws     InvalidInputError in same conditions as
 192          *      parseRequestedFromFile().
 193          *
 194          * This method behaves as parseRequestedFromFile(), but reads the
 195          * selections from a string instead of a file.
 196          * This method is mainly used for testing.
 197          *
 198          * \see parseRequestedFromFile()
 199          */
 200         void parseRequestedFromString(const std::string &str);
 201
 202     private:
 203         class Impl;
 204
 205         PrivateImplPointer<Impl> impl_;
 206
 207         /*! \brief
 208          * Needed for handling delayed selection parsing requests.
 209          */
 210         friend class SelectionOptionStorage;
 211 };
 212
 213 } // namespace gmx
 214
 215 #endif